zent

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Properties

I18nProvider

Variables

Functions

Type aliases

$FieldSetBuilderChildren

$FieldSetBuilderChildren<ChildBuilders>: {[ Key in keyof ChildBuilders]: $GetBuilderModel<ChildBuilders[Key]> }

Type parameters

ChildBuilders: UnknownFieldSetBuilderChildren

$FieldSetValue

$FieldSetValue<Children>: {[ Key in keyof Children]: Children[Key] extends IModel<infer V> ? V : never }

Type parameters

Children: UnknownFieldSetModelChildren

AlertTypes

AlertTypes: "info" | "success" | "warning" | "error" | "hint"

BannerCloseIconColor

BannerCloseIconColor: "grey" | "white"

CascaderItemSelectionState

CascaderItemSelectionState: "on" | "off" | "partial"

CascaderMenuClickHandler

CascaderMenuClickHandler: (node: ICascaderItem, closePopup: () => void) => void

Type declaration

- (node: ICascaderItem, closePopup: () => void): void
- Parameters
  - node: ICascaderItem
  - closePopup: () => void
    - - (): void
      - Returns void
  Returns void

CascaderMenuHoverHandler

CascaderMenuHoverHandler: (node: ICascaderItem) => void

Type declaration

- (node: ICascaderItem): void
- Parameters
  - node: ICascaderItem
  Returns void

CascaderSearchClickHandler

CascaderSearchClickHandler: (path: ICascaderItem[], closePopup: () => void) => void

Type declaration

- (path: ICascaderItem[], closePopup: () => void): void
- Parameters
  - path: ICascaderItem[]
  - closePopup: () => void
    - - (): void
      - Returns void
  Returns void

CascaderSimplifySelectionMode

CascaderSimplifySelectionMode: "excludeDisabled" | "includeDisabled"

CascaderTabsClickHandler

CascaderTabsClickHandler: (node: ICascaderItem, closePopup: () => void) => void

Type declaration

- (node: ICascaderItem, closePopup: () => void): void
- Parameters
  - node: ICascaderItem
  - closePopup: () => void
    - - (): void
      - Returns void
  Returns void

CascaderValue

CascaderValue: string | number

ColorPickerType

ColorPickerType: "default" | "simple"

DateRangeQuickPickerChangeCallback

DateRangeQuickPickerChangeCallback: (value: RangeDate, choosePresetValue?: DateRangeQuickPickerPresetValue) => void

Type declaration

- (value: RangeDate, choosePresetValue?: DateRangeQuickPickerPresetValue): void
- Parameters
  - value: RangeDate
  - Optional choosePresetValue: DateRangeQuickPickerPresetValue
  Returns void

DateRangeQuickPickerPresetValue

DateRangeQuickPickerPresetValue: number | RangeDate

DateRangeQuickPickerValueType

DateRangeQuickPickerValueType: "string" | "number" | "date"

DrawerProps

DrawerProps: IHorizontalDrawerProps | IVerticalDrawerProps

GridColumnContextType

GridColumnContextType: Partial<IGridColumn>

GridFixedType

GridFixedType: "left" | "right" | true

GridPaginationType

GridPaginationType: "default" | "lite" | "mini"

GridRowClassNameType

GridRowClassNameType<Data>: string | ((data: Data, rowIndex: number) => string)

Type parameters

Data = any

GridScrollPosition

GridScrollPosition: "both" | "left" | "right" | "middle"

GridSortType

GridSortType: "desc" | "asc" | ""

GridTextAlign

GridTextAlign: "left" | "right" | "center"

I18nComponentName

I18nComponentName: keyof Omit<ILocaleData, "mark">

I18nLocaleDataType

I18nLocaleDataType<T>: ILocaleData[T] extends () => any ? ReturnType<ILocaleData[T]> : ILocaleData[T]

Type parameters

T: I18nComponentName

I18nLocaleTimePicker

I18nLocaleTimePicker: () => II18nLocaleTimePicker

Type declaration

- (): II18nLocaleTimePicker
- Returns II18nLocaleTimePicker

IAutoCompleteMenuItem

IAutoCompleteMenuItem: string | number | IAutoCompleteMenuObjectItem

IBannerProps

IBannerProps: Omit<IAlertProps, "title"> & { backgroundImage: string }

IButtonGroupProps

IButtonGroupProps: React.HTMLAttributes<HTMLDivElement>

IButtonHtmlType

IButtonHtmlType: "button" | "submit" | "reset"

IButtonSize

IButtonSize: "medium" | "large" | "small"

IButtonType

ICollapseProps

ICollapseProps: ICollapsePropsAccordion | ICollapsePropsMultiple

ICombinedFormTimeRangePickerFieldProps

ICombinedFormTimeRangePickerFieldProps: IFormComponentProps<RangeTime, Omit<ICombinedTimeRangePickerProps, "value">>

IDisabledTime

IDisabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption

Type declaration

- (date?: Date | null, type?: RangeType): IDisabledTimeOption
- Parameters
  - Optional date: Date | null
  - Optional type: RangeType
  Returns IDisabledTimeOption

IDropdownButtonProps

IDropdownButtonProps: IButtonProps

IDropdownProps

IDropdownProps: IPopoverProps

IElevatorLinksProps

IElevatorLinksProps: Omit<IAffixProps, "className" | "style"> & { className?: string; links: IElevatorLinkItem[]; style?: CSSProperties; onClick?: any }

IFormCheckboxFieldProps

IFormCheckboxFieldProps<Value>: IFormComponentProps<boolean, Omit<ICheckboxProps<Value>, "checked">>

Type parameters

Value

IFormCheckboxGroupFieldProps

IFormCheckboxGroupFieldProps<T>: IFormComponentProps<T[], Omit<ICheckboxGroupProps<T>, "value">> & { children?: React.ReactNode }

Type parameters

IFormColorPickerFieldProps

IFormColorPickerFieldProps: IFormComponentProps<string, Omit<IColorPickerProps, "color">>

IFormCombinedDateRangePickerFieldProps

IFormCombinedDateRangePickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<ICombinedDateRangePickerProps<T>, "value">>

Type parameters

T: IValueType

IFormComponentProps

IFormComponentProps<Value, Props, OmitKeys>: Omit<IFormFieldPropsBase<Value>, "touchWhen" | OmitKeys> & { props?: Partial<Props> } & Optional<IFormFieldViewDrivenProps<Value>, "defaultValue"> | Optional<IFormFieldModelDrivenProps<Value>, "defaultValue">

Type parameters

Value
Props
OmitKeys: keyof IFormFieldPropsBase<Value> = never

IFormDatePickerField

IFormDatePickerField<T>: IFormComponentProps<SingleDate, Omit<IDatePickerProps<T>, "value">>

Type parameters

T: IValueType

IFormDateRangePickerFieldProps

IFormDateRangePickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IDateRangePickerProps<T>, "value">>

Type parameters

T: IValueType

IFormDateRangeQuickPickerFieldProps

IFormDateRangeQuickPickerFieldProps: IFormComponentProps<RangeDate, Omit<IDateRangeQuickPickerProps, "value">>

IFormFieldModelProps

IFormFieldModelProps<T>: IFormFieldViewDrivenProps<T> | IFormFieldModelDrivenProps<T>

Type parameters

IFormFieldProps

IFormFieldProps<Value>: IFormFieldPropsBase<Value> & IFormFieldModelProps<Value> & { children: any }

Type parameters

Value

IFormImageUploadFieldProps

IFormImageUploadFieldProps<T>: IFormComponentProps<T[], Omit<IImageUploadProps, "fileList" | "onChange" | "defaultFileList">>

Type parameters

T: IImageUploadFileItem

IFormInputFieldProps

Omit<IInputProps, ...>无法得到正确的类型提示，因此每个类型单独Omit一次再联合

IFormMonthPickerFieldProps

IFormMonthPickerFieldProps<T>: IFormComponentProps<SingleDate, Omit<IMonthPickerProps<T>, "value">>

Type parameters

T: IValueType

IFormNumberInputFieldProps

IFormNumberInputFieldProps<T>: IFormComponentProps<T, Omit<INumberInputDecimalProps, "value"> | Omit<INumberInputIntegerProps, "value">>

Type parameters

IFormQuarterPickerFieldProps

IFormQuarterPickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IQuarterPickerProps<T>, "value">>

Type parameters

T: IValueType

IFormRadioGroupFieldProps

IFormRadioGroupFieldProps<T>: IFormComponentProps<T | null, Omit<IRadioGroupProps<T>, "value">> & { children?: React.ReactNode }

Type parameters

IFormSelectFieldProps

IFormSelectFieldProps<Key, T>: IFormComponentProps<(T | null) | T[], Omit<ISelectProps<Key, T>, "value" | "onChange">>

Type parameters

Key: string | number = string | number
T: ISelectItem<Key> = ISelectItem<Key>

IFormSingleUploadFieldProps

IFormSingleUploadFieldProps<T>: IFormComponentProps<T | null, Omit<ISingleUploadProps, "value" | "onChange">>

Type parameters

T: IUploadFileItem

IFormSwitchFieldProps

IFormSwitchFieldProps: IFormComponentProps<boolean, Omit<ISwitchProps, "checked">>

IFormTimePickerField

IFormTimePickerField: IFormComponentProps<SingleTime, Omit<ITimePickerProps, "value">>

IFormTimeRangePickerFieldProps

IFormTimeRangePickerFieldProps: IFormComponentProps<RangeTime, Omit<ITimeRangePickerProps, "value">>

IFormUploadFieldProps

IFormUploadFieldProps<T>: IFormComponentProps<T[], Omit<IUploadProps, "fileList" | "onChange" | "defaultFileList">>

Type parameters

T: IUploadFileItem

IFormWeekPickerFieldProps

IFormWeekPickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IWeekPickerProps<T>, "value">>

Type parameters

T: IValueType

IFormYearPickerFieldProps

IFormYearPickerFieldProps<T>: IFormComponentProps<SingleDate, Omit<IYearPickerProps<T>, "value">>

Type parameters

T: IValueType

IGridBatchRender

IGridBatchRender: (data: any, position?: "header" | "foot") => React.ReactNode

Type declaration

- (data: any, position?: "header" | "foot"): React.ReactNode
- Parameters
  - data: any
  - Optional position: "header" | "foot"
  Returns React.ReactNode

IGridColumnBodyRenderFunc

IGridColumnBodyRenderFunc<Data>: (data: Data, pos: IGridCellPos, name?: string) => React.ReactNode

Type parameters

Data

Type declaration

- (data: Data, pos: IGridCellPos, name?: string): React.ReactNode
- Parameters
  - data: Data
  - pos: IGridCellPos
  - Optional name: string
  Returns React.ReactNode

IGridInnerFixedType

IGridInnerFixedType: Exclude<GridFixedType, true>

IGridOnExpandHandler

IGridOnExpandHandler<Data>: (data: { data: Data; event: React.MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }) => any

Type parameters

Data = any

Type declaration

- (data: { data: Data; event: React.MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }): any
- Parameters
  - data: { data: Data; event: React.MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }
    - data: Data
    - event: React.MouseEvent<HTMLSpanElement>
    - expanded: boolean
    - index: number
  Returns any

IGridRowClickHandler

IGridRowClickHandler<Data>: (data: Data, index: number, event: React.MouseEvent<HTMLTableRowElement>) => any

Type parameters

Data = any

Type declaration

- (data: Data, index: number, event: React.MouseEvent<HTMLTableRowElement>): any
- Parameters
  - data: Data
  - index: number
  - event: React.MouseEvent<HTMLTableRowElement>
  Returns any

II18nLocalePop

II18nLocalePop: II18nLocaleCommon

IImageOnUploadSuccessReturn

IImageOnUploadSuccessReturn: undefined | null | string | { src: string; thumbSrc: string }

IImageUploadItemProps

IImageUploadItemProps: IUploadItemProps<IImageUploadFileItem> & { onPreview: any }

IImageUploadPreviewHandler

IImageUploadPreviewHandler: (file: IImageUploadFileItem, fileList: IImageUploadFileItem[]) => void

Type declaration

- (file: IImageUploadFileItem, fileList: IImageUploadFileItem[]): void
- Parameters
  - file: IImageUploadFileItem
  - fileList: IImageUploadFileItem[]
  Returns void

IIndicator

IIndicator: FC<IIndicatorProps> & { Step: typeof Step }

IIndicatorProps

IIndicatorProps: Omit<IStepsProps, "type">

IInputChangeEvent

IInputChangeEvent: IInputClearEvent | React.ChangeEvent<HTMLInputElement>

IInputProps

IInputProps: IInputCoreProps | ITextAreaProps

IMaybeError

IMaybeError<T>: IValidateResult<T> | null | undefined

Type parameters

IPopoverHoverTriggerContext

IPopoverHoverTriggerContext: Required<IHoverTriggerCompatibleProps>

IProgressFormatFn

IProgressFormatFn: (precent: number) => React.ReactNode

Type declaration

- (precent: number): React.ReactNode
- Parameters
  - precent: number
  Returns React.ReactNode

IProgressStatus

IProgressStatus: "normal" | "success" | "exception"

IProgressType

IProgressType: "line" | "circle"

IPromptProps

IPromptProps: IAlertProps & { type: PromptType }

ISelectProps

ISelectProps<Key, Item>: ISelectMultiProps<Key, Item> | ISelectSingleProps<Key, Item>

Type parameters

Key: string | number = string | number
Item: ISelectItem<Key> = ISelectItem<Key>

ISelectSize

ISelectSize: "xs" | "s" | "m" | "l" | "xl"

ISingleUploadItemProps

ISingleUploadItemProps: IUploadItemProps<IUploadFileItem>

ISliderProps

ISliderProps: ISliderSingleProps | ISliderRangeProps

ITabOverflowMode

ITabOverflowMode: "slide" | "anchor"

ITabPanelElement

ITabPanelElement<TabPanelProps>: React.ReactElement<PropsWithChildren<TabPanelProps>>

Type parameters

TabPanelProps

ITimePickerProps

ITimePickerProps: ISingleTimePickerProps

ITreeSize

ITreeSize: "medium" | "small" | "large"

IUploadFileItemInner

IUploadFileItemInner<UPLOAD_ITEM>: UPLOAD_ITEM & {}

文件项对象的内部属性扩展类型，内部不再使用，且将于 v10 删除为了兼容外部已经使用的情况，保留该类型及相关使用了该类型的对外暴露的API

Type parameters

UPLOAD_ITEM: IUploadFileItem

IUploadOnChangeHandler

IUploadOnChangeHandler<Value, UPLOAD_ITEM>: (value: Value, detail?: IUploadChangeDetail<UPLOAD_ITEM>) => void

Type parameters

Value
UPLOAD_ITEM: IUploadFileItem

Type declaration

- (value: Value, detail?: IUploadChangeDetail<UPLOAD_ITEM>): void
- Parameters
  - value: Value
  - Optional detail: IUploadChangeDetail<UPLOAD_ITEM>
  Returns void

IUploadOnErrorHandler

IUploadOnErrorHandler: <Type>(type: Type, data: IUploadErrorMessageConfigMap[Type]) => void

Type declaration

- <Type>(type: Type, data: IUploadErrorMessageConfigMap[Type]): void
- Type parameters
  - Type: keyof IUploadErrorMessageConfigMap
  Parameters
  - type: Type
  - data: IUploadErrorMessageConfigMap[Type]
  Returns void

IUploadOnUploadHandler

IUploadOnUploadHandler<ON_UPLOAD_SUCCESS_RETURN>: (file: File, report: (percent: number) => void) => Promise<ON_UPLOAD_SUCCESS_RETURN>

Type parameters

ON_UPLOAD_SUCCESS_RETURN = void

Type declaration

- (file: File, report: (percent: number) => void): Promise<ON_UPLOAD_SUCCESS_RETURN>
- Parameters
  - file: File
  - report: (percent: number) => void
    - - (percent: number): void
      - Parameters
        
        percent: number
        
        Returns void
  Returns Promise<ON_UPLOAD_SUCCESS_RETURN>

IUploadTipConfig

IUploadTipConfig<P>: P & { formattedMaxSize: string | null }

Type parameters

IUploadTipsFunc

IUploadTipsFunc<PROPS>: (config: IUploadTipConfig<PROPS>) => React.ReactNode

Type parameters

PROPS

Type declaration

- (config: IUploadTipConfig<PROPS>): React.ReactNode
- Parameters
  - config: IUploadTipConfig<PROPS>
  Returns React.ReactNode

IValidator

IValidator<T>: IAsyncValidator<T> | ISyncValidator<T>

Type parameters

IValidators

IValidators<T>: readonly IValidator<T>[]

Type parameters

IValueType

IValueType: "date" | "number" | "string"

IVerticalInnerTab

IVerticalInnerTab<Id>: IInnerTab<Id> | IVerticalDivide

Type parameters

IVerticalTab

IVerticalTab<Id>: ITab<Id> | IVerticalDivide

Type parameters

IVerticalTabPanelProps

IVerticalTabPanelProps<Id>: ITabPanelProps<Id> | IVerticalDivide

Type parameters

IconType

InputType

InputType: "text" | "number" | "password" | "textarea"

InputWidthSizeType

InputWidthSizeType: "xs" | "s" | "m" | "l" | "xl"

LayoutBreakPointName

LayoutBreakPointName: keyof typeof LayoutBreakPoint

LocaleMark

LocaleMark: "zh-CN" | "en-US" | "ja-JP"

PaginationChangeHandler

PaginationChangeHandler: (detail: { current: number; pageSize: number }) => any

Type declaration

- (detail: { current: number; pageSize: number }): any
- Parameters
  - detail: { current: number; pageSize: number }
    - current: number
    - pageSize: number
  Returns any

PaginationLayoutFunction

PaginationLayoutFunction: (options: IPaginationLayoutOptions) => PaginationLayout[]

Type declaration

- (options: IPaginationLayoutOptions): PaginationLayout[]
- Parameters
  - options: IPaginationLayoutOptions
  Returns PaginationLayout[]

PopPositions

PopoverAnchorGetElementFn

PopoverAnchorGetElementFn: (node: Element | Text | null) => Element | Text | null

Type declaration

- (node: Element | Text | null): Element | Text | null
- Parameters
  - node: Element | Text | null
  Returns Element | Text | null

PresetColors

PresetColors: string[]

PromptType

PromptType: "warning" | "strongHint" | "weakHint"

RangeDate

RangeDate: [SingleDate | null, SingleDate | null]

RangeTime

RangeTime: [string, string]

SingleDate

SingleDate: string | number | Date

SingleTime

SingleTime: string

StatusBarType

StatusBarType: "info" | "waiting" | "success" | "error"

TabType

TabType: "normal" | "card" | "button"

TextMarkFindChunksFunction

TextMarkFindChunksFunction: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]

Type declaration

- (options: Omit<ITextMarkFindAllParameters, "findChunks">): ITextMarkChunk[]
- Parameters
  - options: Omit<ITextMarkFindAllParameters, "findChunks">
  Returns ITextMarkChunk[]

TextMarkSanitizeFunction

TextMarkSanitizeFunction: (str: string) => string

Type declaration

- (str: string): string
- Parameters
  - str: string
  Returns string

TextMarkSearchWords

TextMarkSearchWords: string | RegExp

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Adapted from https://github.com/bvaughn/highlight-words-core/blob/master/src/utils.js

TransferColumnType

TransferColumnType: ({ name: string; title?: React.ReactNode } & Omit<IGridColumn<ITransferData>, "title" | "name">)[]

TransferDirection

TransferDirection: "left" | "right"

TransferType

TransferType: OneRequired & ITransfer

TreeRootIdArray

TreeRootIdArray: TArray<string | number>

Properties

I18nProvider

I18nProvider: Provider<ILocaleData>

Variables

Const Affix

Affix: ForwardRefExoticComponent<IAffixProps & RefAttributes<IAffixImperativeHandlers>> = ...

Const Banner

Banner: FC<IBannerProps> = ...

Const ButtonGroup

ButtonGroup: FC<IButtonGroupProps> = ...

Const Carousel

Carousel: typeof Swiper = ...

Const CombinedPanelRangePicker

CombinedPanelRangePicker: FC<IProps> = ...

Const CombinedTimeRangePicker

CombinedTimeRangePicker: React.FC<ICombinedTimeRangePickerProps> = ...

Const DEFAULT_RENDER_KEY

DEFAULT_RENDER_KEY: ITreeRenderKey = ...

Const Disabled

Disabled: React.FC<IDisabledProps> = ...

Const DisabledContext

DisabledContext: Context<IDisabledContext> = ...

Const Drawer

Drawer: React.FC<DrawerProps> = ...

Const Dropdown

Dropdown: React.FC<IDropdownProps> = ...

Const DropdownButton

DropdownButton: React.FC<IDropdownButtonProps> = ...

Const DropdownNav

DropdownNav: React.FC<IDropdownNavProps> = ...

Const DropdownPosition

DropdownPosition: __module = ...

Const Elevator

Elevator: IElevator = ...

Const ElevatorAnchor

ElevatorAnchor: FC<IElevatorAnchorProps> = ...

Const ElevatorLinks

ElevatorLinks: VFC<IElevatorLinksProps> = ...

Const FormColorPickerField

FormColorPickerField: React.FunctionComponent<IFormColorPickerFieldProps> = ...

Const FormCombinedTimeRangePickerField

FormCombinedTimeRangePickerField: React.FC<ICombinedFormTimeRangePickerFieldProps> = ...

Const FormContext

FormContext: Context<IZentFormContext> = ...

Const FormControl

FormControl: ForwardRefExoticComponent<IFormControlProps & RefAttributes<HTMLDivElement>> = ...

Const FormDateRangeQuickPickerField

FormDateRangeQuickPickerField: React.FC<IFormDateRangeQuickPickerFieldProps> = ...

Const FormDescription

FormDescription: React.FunctionComponent<IFormDescriptionProps> = ...

Const FormError

FormError: ForwardRefExoticComponent<IFormErrorProps & RefAttributes<HTMLDivElement>> = ...

Const FormInputField

FormInputField: React.FunctionComponent<IFormInputFieldProps> = ...

Const FormNotice

FormNotice: React.FC<IFormNoticeProps> = ...

Const FormSwitchField

FormSwitchField: React.FunctionComponent<IFormSwitchFieldProps> = ...

Const FormTimePickerField

FormTimePickerField: React.FunctionComponent<IFormTimePickerField> = ...

Const FormTimeRangePickerField

FormTimeRangePickerField: React.FunctionComponent<IFormTimeRangePickerFieldProps> = ...

Const GridColumnProvider

GridColumnProvider: Provider<Partial<IGridColumn<any>>> = ...

Const IMEComposition

IMEComposition: React.FC<IIMECompositionProps> = ...

Const Icon

Icon: ForwardRefExoticComponent<IIconProps & RefAttributes<HTMLElement>> = ...

Const Indicator

Indicator: IIndicator = ...

Const InfiniteScroller

InfiniteScroller: ForwardRefExoticComponent<IInfiniteScrollerProps & RefAttributes<HTMLDivElement>> = ...

Const Label

Label: React.FunctionComponent<ILabelProps> = ...

Const LayoutConfigProvider

LayoutConfigProvider: Provider<ILayoutConfig> = ...

Const Link

Link: ForwardRefExoticComponent<ILinkProps & RefAttributes<HTMLAnchorElement>> = ...

Const LinkTag

LinkTag: ForwardRefExoticComponent<ILinkTagProps & RefAttributes<HTMLDivElement>> = ...

Const Notify

Notify: { clear: (containerId: any) => void; config: (options: any) => void; error: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number; info: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number; success: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number; warn: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number } = ...

Type declaration

clear: (containerId: any) => void
- - (containerId: any): void
  - Parameters
    - containerId: any
    Returns void
config: (options: any) => void
- - (options: any): void
  - Parameters
    - options: any
    Returns void
error: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number
- - (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string): number
  - Parameters
    - text: ReactNode
    - Optional duration: number
    - Optional callback: () => void
      - (): void
        
        Returns void
    - Optional containerSelector: string
    - Optional className: string
    Returns number
info: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number
- - (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string): number
  - Parameters
    - text: ReactNode
    - Optional duration: number
    - Optional callback: () => void
      - (): void
        
        Returns void
    - Optional containerSelector: string
    - Optional className: string
    Returns number
success: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number
- - (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string): number
  - Parameters
    - text: ReactNode
    - Optional duration: number
    - Optional callback: () => void
      - (): void
        
        Returns void
    - Optional containerSelector: string
    - Optional className: string
    Returns number
warn: (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string) => number
- - (text: ReactNode, duration?: number, callback?: () => void, containerSelector?: string, className?: string): number
  - Parameters
    - text: ReactNode
    - Optional duration: number
    - Optional callback: () => void
      - (): void
        
        Returns void
    - Optional containerSelector: string
    - Optional className: string
    Returns number

Const Password

Password: { displayName: string } = ...

Type declaration

- (props: IInputCoreProps): Element
- Parameters
  - props: IInputCoreProps
  Returns Element
displayName: string

Const Placeholder

Placeholder: { Circle: typeof default; Rectangle: typeof default; RichTextBlock: typeof default; TextBlock: typeof default; TextRow: typeof default; TextRowDashed: typeof default } = ...

Type declaration

Circle: typeof default
Rectangle: typeof default
RichTextBlock: typeof default
TextBlock: typeof default
TextRow: typeof default
TextRowDashed: typeof default

Const PopoverHoverTriggerContext

PopoverHoverTriggerContext: Context<Required<IHoverTriggerCompatibleProps>> = ...

Const Portal

Portal: ForwardRefExoticComponent<IPortalProps & RefAttributes<IPortalImperativeHandlers>> = ...

Const Progress

Progress: React.FC<IProgressProps> = ...

Const Prompt

Prompt: FC<IPromptProps> = ...

Const SelectTag

SelectTag: ForwardRefExoticComponent<ISelectTagProps & RefAttributes<HTMLDivElement>> = ...

Const SingleCalendarDatePanelPicker

SingleCalendarDatePanelPicker: React.FC<IDatePickerPanelProps> = ...

Const StatusBar

StatusBar: FC<IStatusBarProps> = ...

Sweetalert

Sweetalert: { alert: (config?: IAlertOption) => any; confirm: (config?: IConfirmOption) => any; info: (config?: IAlertOption) => any }

Type declaration

alert: (config?: IAlertOption) => any
- - (config?: IAlertOption): any
  - Parameters
    - config: IAlertOption = {}
    Returns any
confirm: (config?: IConfirmOption) => any
- - (config?: IConfirmOption): any
  - Parameters
    - config: IConfirmOption = {}
    Returns any
info: (config?: IAlertOption) => any
- - (config?: IAlertOption): any
  - Parameters
    - config: IAlertOption = {}
    Returns any

Const Tag

Tag: ForwardRefExoticComponent<ITagProps & RefAttributes<HTMLDivElement>> = ...

Const TimePicker

TimePicker: React.FC<ITimePickerProps> = ...

Const TimeRangePicker

TimeRangePicker: React.FC<ITimeRangePickerProps> = ...

Const Transfer

Transfer: React.FC<TransferType> = ...

Const WindowResizeHandler

WindowResizeHandler: React.FC<IWindowResizeHandlerProps> = ...

The event handler got a second parameter: {deltaX, deltaY}. The onResize callback is throttled to run only once in a frame, you don't need to throttle the callback.

Const WindowScrollHandler

WindowScrollHandler: React.FC<IWindowScrollHandler> = ...

onScroll is throttled to run only once in a frame, you don't have to throttle your callback.

scroll event on element does not bubble, but the scroll event on document does. https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event https://developer.mozilla.org/en-US/docs/Web/API/Element/scroll_event

Const targetMap

targetMap: WeakMap<EventTarget, TargetEventHandlers<string>> = ...

Functions

BlockLoading

BlockLoading(props: IBlockLoadingProps): Element

- Defined in packages/zent/src/loading/BlockLoading.tsx:8
Parameters
- props: IBlockLoadingProps
Returns Element

ButtonDirective

ButtonDirective<ChildProps>(props: IButtonDirectiveProps<ChildProps>): Element

- Defined in packages/zent/src/button/Directive.tsx:50
Type parameters
- ChildProps: IButtonDirectiveChildProps
Parameters
- props: IButtonDirectiveProps<ChildProps>
Returns Element

Checkbox

Checkbox<Value>(props: ICheckboxProps<Value>): Element

- Defined in packages/zent/src/checkbox/Checkbox.tsx:63
Type parameters
- Value
Parameters
- props: ICheckboxProps<Value>
Returns Element

Const CombinedDateRangePicker

CombinedDateRangePicker<T>(props: ICombinedDateRangePickerProps<T>): Element

- Defined in packages/zent/src/date-picker/CombinedDateRangePicker.tsx:38
Type parameters
- T: IValueType = "string"
Parameters
- props: ICombinedDateRangePickerProps<T>
Returns Element

Const DatePicker

DatePicker<T>(props: IDatePickerProps<T>): Element

- Defined in packages/zent/src/date-picker/DatePicker.tsx:37
Type parameters
- T: IValueType = "string"
Parameters
- props: IDatePickerProps<T>
Returns Element

Const DateRangePicker

DateRangePicker<T>(props: IDateRangePickerProps<T>): Element

- Defined in packages/zent/src/date-picker/DateRangePicker.tsx:39
Type parameters
- T: IValueType = "string"
Parameters
- props: IDateRangePickerProps<T>
Returns Element

Const DropdownClickTrigger

DropdownClickTrigger<ChildProps>(__namedParameters: IPopoverClickTriggerProps<ChildProps>): Element

- Defined in packages/zent/src/dropdown/Dropdown.tsx:47
Type parameters
- ChildProps: IPopoverClickTriggerChildProps = IPopoverClickTriggerChildProps
Parameters
- __namedParameters: IPopoverClickTriggerProps<ChildProps>
Returns Element

Const DropdownContent

DropdownContent(__namedParameters: IPopoverContentProps): Element

- Defined in packages/zent/src/dropdown/Dropdown.tsx:49
Parameters
- __namedParameters: IPopoverContentProps
Returns Element

Const DropdownHoverTrigger

DropdownHoverTrigger<ChildProps>(props: IPopoverHoverTriggerProps<ChildProps>): Element

- Defined in packages/zent/src/dropdown/Dropdown.tsx:48
Type parameters
- ChildProps: IPopoverHoverTriggerChildProps = IPopoverHoverTriggerChildProps
Parameters
- props: IPopoverHoverTriggerProps<ChildProps>
Returns Element

Const EventHandler

EventHandler<E, N, T>(__namedParameters: IEventHandlerProps<E, N, T>): any

- Defined in packages/zent/src/utils/component/event-handler/index.ts:55
Type parameters
- E: Event
- N: string
- T: EventTarget = HTMLElement
Parameters
- __namedParameters: IEventHandlerProps<E, N, T>
Returns any

FieldSet

FieldSet<T>(props: IFieldSetModelDrivenProps<T> | IFieldSetViewDrivenProps<T>): Element

- Defined in packages/zent/src/form/FieldSet.tsx:60
Type parameters
- T: UnknownFieldSetModelChildren
Parameters
- props: IFieldSetModelDrivenProps<T> | IFieldSetViewDrivenProps<T>
Returns Element

FormCheckboxField

FormCheckboxField<Value>(props: IFormCheckboxFieldProps<Value>): Element

- Defined in packages/zent/src/form/form-components/CheckboxField.tsx:42
Type parameters
- Value
Parameters
- props: IFormCheckboxFieldProps<Value>
Returns Element

FormCheckboxGroupField

FormCheckboxGroupField<T>(props: IFormCheckboxGroupFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/CheckboxGroupField.tsx:27
Type parameters
- T
Parameters
- props: IFormCheckboxGroupFieldProps<T>
Returns Element

Const FormCombinedDateRangePickerField

FormCombinedDateRangePickerField<T>(props: IFormCombinedDateRangePickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/CombinedDateRangePickerField.tsx:17
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormCombinedDateRangePickerFieldProps<T>
Returns Element

Const FormDatePickerField

FormDatePickerField<T>(props: IFormDatePickerField<T>): Element

- Defined in packages/zent/src/form/form-components/DatePickerField.tsx:16
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormDatePickerField<T>
Returns Element

Const FormDateRangePickerField

FormDateRangePickerField<T>(props: IFormDateRangePickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/DateRangePickerField.tsx:14
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormDateRangePickerFieldProps<T>
Returns Element

FormField

FormField<Value>(props: IFormFieldProps<Value>): Element

- Defined in packages/zent/src/form/Field.tsx:76
Type parameters
- Value
Parameters
- props: IFormFieldProps<Value>
Returns Element

FormImageUploadField

FormImageUploadField<T>(props: IFormImageUploadFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/ImageUploadField.tsx:33
Type parameters
- T: IImageUploadFileItem
Parameters
- props: IFormImageUploadFieldProps<T>
Returns Element

Const FormMonthPickerField

FormMonthPickerField<T>(props: IFormMonthPickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/MonthPickerField.tsx:14
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormMonthPickerFieldProps<T>
Returns Element

FormNumberInputField

FormNumberInputField<T>(props: IFormNumberInputFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/NumberInputField.tsx:15
Type parameters
- T: string | number = number
Parameters
- props: IFormNumberInputFieldProps<T>
Returns Element

Const FormQuarterPickerField

FormQuarterPickerField<T>(props: IFormQuarterPickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/QuarterPickerField.tsx:14
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormQuarterPickerFieldProps<T>
Returns Element

FormRadioGroupField

FormRadioGroupField<T>(props: IFormRadioGroupFieldProps<T | null>): Element

- Defined in packages/zent/src/form/form-components/RadioGroupField.tsx:37
Type parameters
- T
Parameters
- props: IFormRadioGroupFieldProps<T | null>
Returns Element

FormSelectField

FormSelectField<Key, T>(props: IFormSelectFieldProps<Key, T>): Element

- Defined in packages/zent/src/form/form-components/SelectField.tsx:20
Type parameters
- Key: string | number = string | number
- T: ISelectItem<Key, T> = ISelectItem<Key>
Parameters
- props: IFormSelectFieldProps<Key, T>
Returns Element

FormSingleUploadField

FormSingleUploadField<T>(props: IFormSingleUploadFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/SingleUploadField.tsx:24
Type parameters
- T: IUploadFileItem
Parameters
- props: IFormSingleUploadFieldProps<T>
Returns Element

FormUploadField

FormUploadField<T>(props: IFormUploadFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/UploadField.tsx:29
Type parameters
- T: IUploadFileItem
Parameters
- props: IFormUploadFieldProps<T>
Returns Element

Const FormWeekPickerField

FormWeekPickerField<T>(props: IFormWeekPickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/WeekPickerField.tsx:14
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormWeekPickerFieldProps<T>
Returns Element

Const FormYearPickerField

FormYearPickerField<T>(props: IFormYearPickerFieldProps<T>): Element

- Defined in packages/zent/src/form/form-components/YearPickerField.tsx:14
Type parameters
- T: IValueType = "string"
Parameters
- props: IFormYearPickerFieldProps<T>
Returns Element

FullScreenLoading

FullScreenLoading(props: IFullScreenLoadingProps): Element

- Defined in packages/zent/src/loading/FullScreenLoading.tsx:16
Parameters
- props: IFullScreenLoadingProps
Returns Element

InlineLoading

InlineLoading(props: IInlineLoadingProps): Element

- Defined in packages/zent/src/loading/InlineLoading.tsx:7
Parameters
- props: IInlineLoadingProps
Returns Element

Const MonthPicker

MonthPicker<T>(props: IMonthPickerProps<T>): Element

- Defined in packages/zent/src/date-picker/MonthPicker.tsx:30
Type parameters
- T: IValueType = "string"
Parameters
- props: IMonthPickerProps<T>
Returns Element

Notice

Notice(__namedParameters: INoticeProps): Element

- Defined in packages/zent/src/notice/Notice.tsx:59
Parameters
- __namedParameters: INoticeProps
Returns Element

PopoverClickTrigger

PopoverClickTrigger<ChildProps>(__namedParameters: IPopoverClickTriggerProps<ChildProps>): Element

- Defined in packages/zent/src/popover/trigger/ClickTrigger.tsx:36
Type parameters
- ChildProps: IPopoverClickTriggerChildProps = IPopoverClickTriggerChildProps
Parameters
- __namedParameters: IPopoverClickTriggerProps<ChildProps>
Returns Element

PopoverFocusTrigger

PopoverFocusTrigger<ChildProps>(__namedParameters: IPopoverFocusTriggerProps<ChildProps>): Element

- Defined in packages/zent/src/popover/trigger/FocusTrigger.tsx:22
Type parameters
- ChildProps: IPopoverFocusTriggerChildProps = IPopoverFocusTriggerChildProps
Parameters
- __namedParameters: IPopoverFocusTriggerProps<ChildProps>
Returns Element

PopoverHoverTrigger

PopoverHoverTrigger<ChildProps>(props: IPopoverHoverTriggerProps<ChildProps>): Element

- Defined in packages/zent/src/popover/trigger/HoverTrigger.tsx:50
todo

better enter/leave algorithm

Type parameters
- ChildProps: IPopoverHoverTriggerChildProps = IPopoverHoverTriggerChildProps
Parameters
- props: IPopoverHoverTriggerProps<ChildProps>
Returns Element

Const QuarterPicker

QuarterPicker<T>(props: IQuarterPickerProps<T>): Element

- Defined in packages/zent/src/date-picker/QuarterPicker.tsx:30
Type parameters
- T: IValueType = "string"
Parameters
- props: IQuarterPickerProps<T>
Returns Element

Radio

Radio<Value>(props: IRadioProps<Value> & { labelStyle?: React.CSSProperties }): Element

- Defined in packages/zent/src/radio/Radio.tsx:11
Type parameters
- Value
Parameters
- props: IRadioProps<Value> & { labelStyle?: React.CSSProperties }
Returns Element

RadioButton

RadioButton<Value>(props: IRadioProps<Value>): Element

- Defined in packages/zent/src/radio/RadioButton.tsx:10
Type parameters
- Value
Parameters
- props: IRadioProps<Value>
Returns Element

RadioGroup

RadioGroup<Value>(props: IRadioGroupProps<Value>): Element

- Defined in packages/zent/src/radio/Group.tsx:19
Type parameters
- Value
Parameters
- props: IRadioGroupProps<Value>
Returns Element

TextMark

TextMark(__namedParameters: ITextMarkProps): Element

- Defined in packages/zent/src/text-mark/TextMark.tsx:70
Highlights all occurrences of search terms (searchText) within a string (textToHighlight). This function returns an array of strings and s (wrapping highlighted words).

Parameters
- __namedParameters: ITextMarkProps
Returns Element

Const WeekPicker

WeekPicker<T>(props: IWeekPickerProps<T>): Element

- Defined in packages/zent/src/date-picker/WeekPicker.tsx:40
Type parameters
- T: IValueType = "string"
Parameters
- props: IWeekPickerProps<T>
Returns Element

WindowEventHandler

WindowEventHandler<K>(__namedParameters: IWindowEventHandlerProps<K>): Element

- Defined in packages/zent/src/utils/component/WindowEventHandler.tsx:23
Type parameters
- K: keyof WindowEventMap
Parameters
- __namedParameters: IWindowEventHandlerProps<K>
Returns Element

Const YearPicker

YearPicker<T>(props: IYearPickerProps<T>): Element

- Defined in packages/zent/src/date-picker/YearPicker.tsx:29
Type parameters
- T: IValueType = "string"
Parameters
- props: IYearPickerProps<T>
Returns Element

addEventListener

addEventListener<T>(target: T, eventName: string, listener: EventListener, options?: AddEventListenerOptions): () => void

- Defined in packages/zent/src/utils/component/event-handler/index.ts:10
Type parameters
- T: EventTarget = HTMLElement
Parameters
- target: T
- eventName: string
- listener: EventListener
- Optional options: AddEventListenerOptions
Returns () => void
- - (): void
  - Returns void

alert

alert(config?: IAlertOption): any

- Defined in packages/zent/src/sweetalert/index.tsx:122
Parameters
- config: IAlertOption = {}
Returns any

caselessMatchFilterOption

caselessMatchFilterOption(searchText: string, item: ISelectMenuItem): boolean

- Defined in packages/zent/src/select-menu/SelectMenu.tsx:41
Parameters
- searchText: string
- item: ISelectMenuItem
Returns boolean

closeDialog

closeDialog(dialogId: string, options?: ICloseDialogOption): void

- Defined in packages/zent/src/dialog/open.tsx:87
Parameters
- dialogId: string
- options: ICloseDialogOption = {}
Returns void

confirm

confirm(config?: IConfirmOption): any

- Defined in packages/zent/src/sweetalert/index.tsx:128
Parameters
- config: IConfirmOption = {}
Returns any

createUseIMEComposition

createUseIMEComposition(option?: ICreateUseIMECompositionOption): <OnChange>(propValue: string, onChangeProp?: OnChange, onCompositionStartProp?: CompositionEventHandler<ElementType>, onCompositionEndProp?: CompositionEventHandler<ElementType>) => IUseIMECompositionResult<OnChange>

- Defined in packages/zent/src/ime-composition/hooks.ts:19
Parameters
- Optional option: ICreateUseIMECompositionOption
Returns <OnChange>(propValue: string, onChangeProp?: OnChange, onCompositionStartProp?: CompositionEventHandler<ElementType>, onCompositionEndProp?: CompositionEventHandler<ElementType>) => IUseIMECompositionResult<OnChange>
- - <OnChange>(propValue: string, onChangeProp?: OnChange, onCompositionStartProp?: CompositionEventHandler<ElementType>, onCompositionEndProp?: CompositionEventHandler<ElementType>): IUseIMECompositionResult<OnChange>
  - Type parameters
    - OnChange: (...args: any[]) => any
    Parameters
    - propValue: string
    - Optional onChangeProp: OnChange
    - Optional onCompositionStartProp: CompositionEventHandler<ElementType>
    - Optional onCompositionEndProp: CompositionEventHandler<ElementType>
    Returns IUseIMECompositionResult<OnChange>

defaultGetValidateOption

defaultGetValidateOption(): ValidateOption

- Defined in packages/zent/src/form/Field.tsx:31
Returns ValidateOption

Const getDecimal

getDecimal(step: string | number): number

- Defined in packages/zent/src/slider/Slider.tsx:16
Parameters
- step: string | number
Returns number

getRadioState

getRadioState<Value>(disabledCtx: IDisabledContext, groupCtx: IRadioContext<Value> | null, props: IRadioProps<Value>): { checked: boolean; disabled: boolean; readOnly: boolean }

- Defined in packages/zent/src/radio/AbstractRadio.tsx:89
Type parameters
- Value
Parameters
- disabledCtx: IDisabledContext
- groupCtx: IRadioContext<Value> | null
- props: IRadioProps<Value>
Returns { checked: boolean; disabled: boolean; readOnly: boolean }
- checked: boolean
- disabled: boolean
- readOnly: boolean

Const info

info(config?: IAlertOption): any

- Defined in packages/zent/src/sweetalert/index.tsx:126
Parameters
- config: IAlertOption = {}
Returns any

isViewDrivenProps

isViewDrivenProps<T>(props: IFormFieldModelProps<T>): props is IFormFieldViewDrivenProps<T>

- Defined in packages/zent/src/form/shared.tsx:83
Type parameters
- T
Parameters
- props: IFormFieldModelProps<T>
Returns props is IFormFieldViewDrivenProps<T>

openDialog

openDialog(options?: Partial<IOpenDialogOption>): (triggerOnClose?: boolean) => void

- Defined in packages/zent/src/dialog/open.tsx:113
Parameters
- options: Partial<IOpenDialogOption> = {}
Returns (triggerOnClose?: boolean) => void
- - (triggerOnClose?: boolean): void
  - Parameters
    - triggerOnClose: boolean = true
    Returns void

previewImage

previewImage(options?: IPreviewImageConfig): void

- Defined in packages/zent/src/preview-image/previewImage.tsx:15
Parameters
- options: IPreviewImageConfig = {}
Returns void

smoothScroll

smoothScroll(el: HTMLElement | Window, x: number, y: number, duration?: number): Promise<unknown>

- Defined in packages/zent/src/utils/scroll.ts:78
scrolls element with a smooth behavior

method

smoothScroll

Parameters
- el: HTMLElement | Window
  
  element to scroll
- x: number
  
  target position x
- y: number
  
  target position y
- duration: number = ...
  
  animation duration
Returns Promise<unknown>

useEventHandler

useEventHandler<E, N, T>(target: T, eventName: N, listener: (event: E) => void, options?: AddEventListenerOptions): void

- Defined in packages/zent/src/utils/component/event-handler/index.ts:23
Type parameters
- E: Event
- N: string
- T: EventTarget = HTMLElement
Parameters
- target: T
- eventName: N
- listener: (event: E) => void
  - - (event: E): void
    - Parameters
      - event: E
      Returns void
- Optional options: AddEventListenerOptions
Returns void

useFormChild

useFormChild<Value>(model: BasicModel<Value>, scrollAnchorRef?: React.RefObject<Element | null | undefined>): void

- Defined in packages/zent/src/form/shared.tsx:234
将 model 关联到一个 DOM 节点，用于自定义 Field 滚动到错误位置的场景。

Type parameters
- Value
Parameters
- model: BasicModel<Value>
  
  需要关联 DOM 节点的 model 对象
- Optional scrollAnchorRef: React.RefObject<Element | null | undefined>
  
  model 对象关联的 DOM 节点
Returns void

useInitialValue

useInitialValue<T>(model: FieldModel<T>, initialValue?: T): void

- Defined in packages/zent/src/form/Field.tsx:44
为 model 设置初始值，初始值会被作为 effect 的依赖，谨慎使用字面量

Type parameters
- T
Parameters
- model: FieldModel<T>
- Optional initialValue: T
Returns void

useObservableBatchedEagerState

useObservableBatchedEagerState<T>(input$: Observable<T>): [value: T, runInBatchContext: (fn: (() => void) | (() => Promise<unknown>)) => void]

- Defined in packages/zent/src/form/formulr/use-observable-batched-eager-state.ts:25
类似 observable-hooks 里的 useObservableEagerState。

input$ 在 runInBatchContext 执行过程中产生的新值，除最后一个外都会被忽略；在 runInBatchContext 之外的更新操作不受影响。

runInBatchContext 中的操作支持异步操作，此时应返回一个 Promise。

使用场景示例：

批量更新 FieldArrayModel 中每一项的值，但又不希望监听 FieldArrayModel.value$ 的回调频繁触发，导致页面不停的被重绘。

Type parameters
- T
Parameters
- input$: Observable<T>
  
  通常是 model.value$
Returns [value: T, runInBatchContext: (fn: (() => void) | (() => Promise<unknown>)) => void]

usePopoverContext

usePopoverContext(): IPopoverContext

- Defined in packages/zent/src/popover/Context.tsx:27
Returns IPopoverContext

useRadioHandler

useRadioHandler<Value>(ctx: IRadioContext<Value> | null, props: IRadioProps<Value>): (event: any) => void

- Defined in packages/zent/src/radio/AbstractRadio.tsx:41
Type parameters
- Value
Parameters
- ctx: IRadioContext<Value> | null
- props: IRadioProps<Value>
Returns (event: any) => void
- - (event: any): void
  - Parameters
    - event: any
    Returns void

useTransfer

useTransfer(params?: ITransferHookParams): ITransferHookResult

- Defined in packages/zent/src/transfer/hooks/useTransfer.ts:10
Parameters
- Optional params: ITransferHookParams
Returns ITransferHookResult

useWindowEventHandler

useWindowEventHandler<K>(eventName: K, listener: (ev: WindowEventMap[K]) => void, options?: AddEventListenerOptions): void

- Defined in packages/zent/src/utils/component/WindowEventHandler.tsx:10
Type parameters
- K: keyof WindowEventMap
Parameters
- eventName: K
- listener: (ev: WindowEventMap[K]) => void
  - - (ev: WindowEventMap[K]): void
    - Parameters
      - ev: WindowEventMap[K]
      Returns void
- Optional options: AddEventListenerOptions
Returns void

withErrorBoundary

withErrorBoundary<P>(__namedParameters?: IWithErrorBoundaryOption<P>): (props: P) => Element

- Defined in packages/zent/src/error-boundary/withErrorBoundary.tsx:12
Type parameters
- P
Parameters
- __namedParameters: IWithErrorBoundaryOption<P> = {}
Returns (props: P) => Element
- - (props: P): Element
  - Parameters
    - props: P
    Returns Element

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Properties

Variables

Functions

Type aliases

$FieldSetBuilderChildren

Type parameters

ChildBuilders: UnknownFieldSetBuilderChildren

$FieldSetValue

Type parameters

Children: UnknownFieldSetModelChildren

AlertTypes

BannerCloseIconColor

CascaderItemSelectionState

CascaderMenuClickHandler

Type declaration

Parameters

node: ICascaderItem

closePopup: () => void

Returns void

Returns void

CascaderMenuHoverHandler

Type declaration

Parameters

node: ICascaderItem

Returns void

CascaderSearchClickHandler

Type declaration

Parameters

path: ICascaderItem[]

closePopup: () => void

Returns void

Returns void

CascaderSimplifySelectionMode

CascaderTabsClickHandler

Type declaration

Parameters

node: ICascaderItem

closePopup: () => void

Returns void

Returns void

CascaderValue

ColorPickerType

DateRangeQuickPickerChangeCallback

Type declaration

Parameters

value: RangeDate

Optional choosePresetValue: DateRangeQuickPickerPresetValue

Returns void

DateRangeQuickPickerPresetValue

DateRangeQuickPickerValueType

DrawerProps

GridColumnContextType

GridFixedType

GridPaginationType

GridRowClassNameType

Type parameters

Data = any

GridScrollPosition

GridSortType

GridTextAlign

I18nComponentName

I18nLocaleDataType

Type parameters

T: I18nComponentName

I18nLocaleTimePicker

Type declaration

Returns II18nLocaleTimePicker

IAutoCompleteMenuItem

IBannerProps

IButtonGroupProps

IButtonHtmlType

IButtonSize

IButtonType

ICollapseProps