54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
:: BASE_DOC ::
|
||
|
||
## API
|
||
|
||
### Calendar Props
|
||
|
||
name | type | default | description | required
|
||
-- | -- | -- | -- | --
|
||
style | Object | - | CSS(Cascading Style Sheets) | N
|
||
custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
|
||
auto-close | Boolean | true | `0.34.0` | N
|
||
confirm-btn | String / Object / Slot | '' | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/calendar/type.ts) | N
|
||
first-day-of-week | Number | 0 | \- | N
|
||
format | Function | - | Typescript：`CalendarFormatType ` `type CalendarFormatType = (day: TDate) => TDate` `type TDateType = 'selected' \| 'disabled' \| 'start' \| 'centre' \| 'end' \| ''` `interface TDate { date: Date; day: number; type: TDateType; className?: string; prefix?: string; suffix?: string;}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/calendar/type.ts) | N
|
||
locale-text | Object | - | Typescript：`CalendarLocaleText` `interface CalendarLocaleText {title?: string; weekdays?: string[]; monthTitle?: string; months?: string[]; confirm?: string;}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/calendar/type.ts) | N
|
||
max-date | Number | - | \- | N
|
||
min-date | Number | - | \- | N
|
||
switch-mode | String | none | options: none/month/year-month | N
|
||
title | String / Slot | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
|
||
type | String | 'single' | options: single/multiple/range | N
|
||
use-popup | Boolean | true | `0.32.0` | N
|
||
using-custom-navbar | Boolean | false | \- | N
|
||
value | Number / Array | - | Typescript：`number \| number[]` | N
|
||
default-value | Number / Array | undefined | uncontrolled property。Typescript：`number \| number[]` | N
|
||
visible | Boolean | false | \- | N
|
||
|
||
### Calendar Events
|
||
|
||
name | params | description
|
||
-- | -- | --
|
||
change | `(value: timestamp)` | `0.28.0`
|
||
close | `(trigger: CalendarTrigger)` | `0.34.0`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/calendar/type.ts)。<br/>`type CalendarTrigger = 'close-btn' \| 'confirm-btn' \| 'overlay'`<br/>
|
||
confirm | `(value: timestamp)` | \-
|
||
panel-change | `(year: number; month: number)` | `1.8.4`
|
||
scroll | `({scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY})` | `1.4.6`。triggered when scrolling
|
||
select | `(value: timestamp)` | `0.28.0`
|
||
|
||
### CSS Variables
|
||
|
||
The component provides the following CSS variables, which can be used to customize styles.
|
||
Name | Default Value | Description
|
||
-- | -- | --
|
||
--td-calendar-active-color | @brand-color | -
|
||
--td-calendar-bg-color | @bg-color-container | -
|
||
--td-calendar-days-color | @text-color-secondary | -
|
||
--td-calendar-item-centre-color | @brand-color-light | -
|
||
--td-calendar-item-disabled-color | @text-color-disabled | -
|
||
--td-calendar-item-suffix-color | @text-color-placeholder | -
|
||
--td-calendar-radius | 24rpx | -
|
||
--td-calendar-selected-color | @text-color-anti | -
|
||
--td-calendar-switch-mode-icon-color | @brand-color | -
|
||
--td-calendar-switch-mode-icon-disabled-color | @brand-color-disabled | -
|
||
--td-calendar-title-color | @text-color-primary | -
|
||
--td-calendar-title-font-size | 18px | - |