npm 包 @thg303/react-persian-datepicker 使用教程

简介

@thg303/react-persian-datepicker 是一款 React 组件,用于创建波斯语日期选择器。它基于 react-datepicker 和波斯历,提供了易用且友好的 UI,支持自定义样式等功能。

安装

在您的项目目录下使用 npm 或 yarn 安装 @thg303/react-persian-datepicker:

--- ------- --------------------------------
- -
---- --- --------------------------------

使用

在您的 React 组件中导入并使用 @thg303/react-persian-datepicker:

------ ------ - -------- - ---- --------
------ ----------------- ---- -----------------------------------

----- ----------- - -- -- -
  ----- -------------- ---------------- - ---------------

  ----- ---------------- - ------ -- -
    ----------------------
  --

  ------ -
    -----
      -------------
      ------------------
        -----------------------
        ---------------------------
      --
    ------
  --
-

------ ------- ------------

Props

@thg303/react-persian-datepicker 接受一些 props 来配置其行为和外观。

selected

  • 类型: Date | null
  • 默认值: null

选择器当前所选日期。

onChange

  • 类型: function
  • 默认值: null

当用户选择日期时,将被调用。

---------------------- ----- ------ --------------- -- ----

minDate

  • 类型: Date
  • 默认值: null

允许选择器选择的最小日期。

maxDate

  • 类型: Date
  • 默认值: null

允许选择器选择的最大日期。

disabled

  • 类型: boolean
  • 默认值: false

禁用选择器。

className

  • 类型: string
  • 默认值: ''

自定义选择器容器的 class 名称。

style

  • 类型: object
  • 默认值: {}

自定义选择器容器的样式。

dateFormat

  • 类型: string
  • 默认值: 'jYYYY/jMM/jDD'

日期格式。

  • jYYYY - 年份 as 4 位数字的波斯历年。
  • jYY - 年份 as 2 位数字的波斯历年。
  • jM - 月份 as 1-2 位数字的波斯历月份。
  • jMM - 月份 as 2 位数字的波斯历月份。
  • jD - 日 as 1-2 位数字的波斯历日。
  • jDD - 日 as 2 位数字的波斯历日。
  • dddd - 完整波斯历星期几的名称。

例如,'jYYYY/jMM/jDD dddd' 将显示 "1399/07/25 چهارشنبه"。

monthLabelText

  • 类型: string
  • 默认值: 'ماه'

月份标签的文本。

nextMonthButtonLabel

  • 类型: string
  • 默认值: 'ماه بعد'

下个月按钮的文本。

previousMonthButtonLabel

  • 类型: string
  • 默认值: 'ماه قبل'

上个月按钮的文本。

todayButtonLabel

  • 类型: string
  • 默认值: 'امروز'

今天按钮的文本。

customInput

  • 类型: JSX.Element
  • 默认值: null

自定义输入。

例如:

------------------
  --------------------------- ---
--

customInputIcon

  • 类型: JSX.Element
  • 默认值: null

自定义输入框旁边的图标。

例如:

------------------
  ------------------------------ ---
--

showMonthDropdown

  • 类型: boolean
  • 默认值: false

显示月份下拉菜单。

showYearDropdown

  • 类型: boolean
  • 默认值: false

显示年份下拉菜单。

dateFormatCalendar

  • 类型: string
  • 默认值: 'jMMMM jYYYY'

日期格式 (在选择器下拉菜单中)。

yearDropdownItemNumber

  • 类型: number
  • 默认值: 10

年份下拉菜单中显示的年数。

scrollableYearDropdown

  • 类型: boolean
  • 默认值: false

年份下拉菜单是否可滚动。

todayHighlight

  • 类型: boolean
  • 默认值: false

高亮显示今天所在的日期。

highlightDates

  • 类型: Array<Date>
  • 默认值: []

需要高亮显示的日期数组。

selectedDateModifier

  • 类型: function
  • 默认值: null

自定义选择器中选定日期的修改器函数。

-------------- ----- -- ----

例如,以下的 modifier 会返回选定日期不在周末的最后一个工作日(星期五):

------------------
  ---------------------------- -- -
    ----- --------- - --------------
    -- ---------- --- - -- --------- --- -- -
      ------ ------------- --------- --- - - -- - ---
    -
    ------ -----
  --
--

customPreviousIcon

  • 类型: JSX.Element
  • 默认值: null

自定义上个月按钮的图标。

例如:

------------------
  --------------------------------- ---
--

customNextIcon

  • 类型: JSX.Element
  • 默认值: null

自定义下个月按钮的图标。

例如:

------------------
  ----------------------------- ---
--

例子

以下是一个完整的例子。

------ ------ - -------- - ---- --------
------ ----------------- ---- -----------------------------------
------ ------------

----- --- - -- -- -
  ----- -------------- ---------------- - ---------------

  ----- ---------------- - ------ -- -
    ----------------------
  --

  ------ -
    ---- ----------------
      -------------
      ------------------
        -----------------------
        ---------------------------
        --------------------------
        -----------------
        ----------------
        ---------------------------
        --------------
        -------------------- ------- --- --------------------
      --
    ------
  --
-

------ ------- ----

结论

@thg303/react-persian-datepicker 提供了创建波斯语日期选择器的易用且友好的 UI,支持自定义样式等功能。希望这篇文章帮助您快速上手使用此组件。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005601281e8991b448de112


猜你喜欢

  • npm包react-wizard-form使用教程

    简介 react-wizard-form是一个npm包,提供了一种简单易用的方式来制作向导形式的表单。它基于React构建。这个包提供了多个功能,例如嵌套表单、自定义表单域验证和样式自定义。

    3 年前
  • npm 包 defyn 使用教程

    在前端开发中,npm 是一个非常有用的包管理器,它能够帮助开发人员快速安装和管理项目所需的第三方包。其中,defyn 是一款用于快速定义 JavaScript 对象结构的 npm 包。

    3 年前
  • npm 包 rgl 使用教程

    前言 rgl 是一款用于实现可拖拽网格布局的 npm 包。它可以帮助开发者快速构建易于调整的网格系统,组织复杂的 UI 布局以及使用响应式布局等功能。本文将会介绍 rgl 的使用教程,以及如何深入学习...

    3 年前
  • npm 包 tslint-alan 使用教程

    在前端开发中,我们经常会遇到代码规范问题,为了更好的维护和管理我们的代码,我们需要遵循一些指定的代码规范来开发我们的应用程序。而 tslint-alan 就是一个非常好用的规范检查 npm 包,它能够...

    3 年前
  • npm 包 fastify-ioredis 使用教程

    简介 fastify-ioredis 是一个 Fastify 插件,它提供了使用 ioredis 客户端在 Fastify 应用中处理 Redis 相关的所有事项的快速和简便的方法。

    3 年前
  • npm 包 mickey-vstar 使用教程

    前言 在前端的开发流程中,经常需要进行状态管理。而在 React 中,最流行的状态管理库莫过于 Redux 了。然而,Redux 本身的使用门槛较高,需要写大量的样板代码,对于中小型项目来说,开销有点...

    3 年前
  • npm 包 bootstrap-mercadolibre 使用教程

    介绍 bootstrap-mercadolibre 是一个基于 Bootstrap 的前端开发工具包,主要为墨西哥电商平台 MercadoLibre 定制的。 它包含了一整套的 UI 组件和样式,可以...

    3 年前
  • npm 包 poc-npm 使用教程

    介绍 poc-npm 是一个 npm 包,它可以帮助前端开发人员快速构建出带有页面模板和模块化结构的项目。在使用 poc-npm 的情况下,开发人员无需手动配置 webpack 和开发环境,只需要简单...

    3 年前
  • npm 包 dubbo-registry 使用教程

    前言 Dubbo 作为一种分布式远程服务调用框架,主要用于解决各个微服务之间的调用问题,同时也提供了注册中心的支持。dubbo-registry 就是 Dubbo 官方封装的注册中心,它可以让我们方便...

    3 年前
  • npm包@psantaria/converter使用教程

    简介 在现代web开发中,前端开发不仅是构建良好用户体验的组成部分,而且还可以使用不同的库、框架和工具,以提高效率和代码可读性。其中一个非常有用的工具是 npm 包 @psantaria/conver...

    3 年前
  • npm 包 airbitz-core-types 使用教程

    前言 airbitz-core-types 是一个开源的 npm 包,用于在 JavaScript 中操作 Airbitz 核心应用程序的所有数据结构。本教程将介绍如何使用该包进行开发。

    3 年前
  • npm 包 best-config 使用教程

    在前端开发中,经常需要读取配置文件来实现一些功能,如:数据库信息、服务器地址、token 等。这时,我们就需要使用配置管理工具来读取配置文件,而 best-config 就是这样一个简单实用的 npm...

    3 年前
  • npm 包eslint-config-skola 使用教程

    前言 随着现代 Web 开发的日益复杂,前端开发的工具和语言也变得越来越多样化。尽管这种变化带来了更好的开发体验和更高的生产力,但也会给代码的可维护性和规范性带来挑战。

    3 年前
  • npm 包 myscaf_cli 使用教程

    前端开发中,经常需要使用一些第三方工具来辅助开发,npm 是 JavaScript 的包管理工具,可以方便地安装、升级、删除各种 JavaScript 包。myscaf_cli 是一款基于 Node....

    3 年前
  • npm 包 vue-laravel-data 使用教程

    引言 在 Web 开发中,前后端数据传递是必不可少的操作之一。而在前端领域,Vue.js 是一个极为流行的 Web 前端框架,它提供了方便快捷的数据绑定及视图更新机制。

    3 年前
  • npm 包 libnfc-js 使用教程

    1. 简介和背景 Node Package Manager(NPM)是一个由 Node.js 提供的第三方模块集中存储的平台。借助全球化的开发者社区,开发者可以从中获取、发布和维护各种有用的代码片段和...

    3 年前
  • npm 包 dubbojs-client 使用教程

    DubboJS 是阿里巴巴调用 RPC 服务的开源项目,dubbojs-client 是在前端中调用 Dubbo 接口的 Node.js 模块化工具。本文会详细介绍如何使用 dubbojs-clien...

    3 年前
  • npm 包 async-bittrex-api-node 使用教程

    如果你是一名前端工程师,并且正在为了编写 Bittrex 的 API 交易功能而苦苦挣扎,那么 async-bittrex-api-node 将会是你的得力助手。这是一个 Node.js 的异步 Ja...

    3 年前
  • npm 包 id-card-helper 使用教程

    概述 npm 是一个 Node.js 的包管理器,可以方便地管理项目中使用的第三方包。在前端开发中,经常需要对身份证号码进行校验或者提取其中的信息,因此一些开发者就开发了相应的 npm 包。

    3 年前
  • npm 包 node-red-contrib-twitter-user-timeline 使用教程

    在前端开发中,社交媒体是一个不可忽视的组成部分。Twitter 是一个热门的社交媒体之一,许多公司和个人都在 Twitter 上拥有自己的账户。而 node-red-contrib-twitter-u...

    3 年前

相关推荐

    暂无文章