@nbicc/common-components ​

Namespaces ​

• FormValidateRules
• TableHelper

Enumerations ​

• FormItemControlType
• NPrintLodopPagingMode
• NPrintPagingMode

Classes ​

• AntDesignVueFormHelper
• AntDesignVueFormItem
• AntDesignVueFormItemControl
• AntDesignVueTableHelper
• AntDesignVueTableHelperOptions
• AutoLoadSelectHelper
• FormHelper
• FormItem
• FormItemControl
• FormValidator
• SimpleStorage
• SimpleStorageManager

Interfaces ​

• AntDesignVueTablePaginationParams
• BuildInValidator
• BuildInValidatorInitialFunc
• BuildInValidatorRule
• ColumnConfig
• FieldStatus
• FormHelperOptions
• FormItemControlOptions
• FormItemOptions
• InnerFormHelperOptions
• NBaseFormExpose
• NButtonEmits
• NDrawerContext
• NDrawerFuncProps
• NDrawerWrapperContext
• NEasyFormEmits
• NEasyFormExpose
• NFormEmits
• NFormFieldLayout
• NFormFieldStatus
• NModalContext
• NModalFuncProps
• NModalWrapperContext
• NPageLayoutEmits
• NSelectEmits
• NSpaceEmits
• NSpecProviderEasyFormConfig
• NSpecProviderFormConfig
• NSpecProviderFormItemConfig
• NTableColumnConfig
• NTableEmits
• NTableExpose
• NTableRowSelection
• NToolbarEmits
• NUploadLimit

Type Aliases ​

AntDesignVueFormItemOptions ​

AntDesignVueFormItemOptions: FormItemOptions & FormItemProps

Defined in ​

dist/src/components/n-form/ant-design-vue-adaptive/ant-design-vue-form-item.d.ts:10

AntDesignVueFormModelField ​

AntDesignVueFormModelField<TYPE>: Pick<AntDesignVueFormItemOptions, "name"> & Partial<Omit<AntDesignVueFormItemOptions, "control" | "name"> & FormItemControlOptions<TYPE>>

Type parameters ​

Defined in ​

dist/src/components/n-form/ant-design-vue-adaptive/ant-design-vue-form-helper.d.ts:9

AntDesignVueFormModelFieldArgs ​

AntDesignVueFormModelFieldArgs<TYPE, CONTROL>: AntDesignVueFormModelField<TYPE> | [AntDesignVueFormModelField<TYPE>, ...any[]] | [AntDesignVueFormModelField<TYPE>, FormItemControlPropsMap[CONTROL], ...any[]]

适应 Ant Design Vue 的表单项的属性. 详见 FormModelFieldArgs

Type parameters ​

Defined in ​

dist/src/components/n-form/ant-design-vue-adaptive/ant-design-vue-form-helper.d.ts:13

Breakpoint ​

Breakpoint: typeof breakpoints[number]

Defined in ​

dist/src/components/utils/hooks/use-responsive/break-point.d.ts:2

ContextSlots ​

ContextSlots: Object

Type declaration ​

Defined in ​

dist/src/components/n-toolbar/toolbar-types.d.ts:31

FormItemControlArgs ​

FormItemControlArgs<TYPE>: [Partial<FormItemControlOptions<TYPE>>, ...any[]]

Type parameters ​

Defined in ​

dist/src/components/form-helper/form-item-control.d.ts:15

FormModelField ​

FormModelField<TYPE>: Pick<FormItemOptions, "name"> & Partial<Omit<FormItemOptions, "control" | "name"> & FormItemControlOptions<TYPE>>

Type parameters ​

Defined in ​

dist/src/components/form-helper/form-helper.d.ts:130

FormModelFieldArgs ​

FormModelFieldArgs<TYPE>: FormModelField<TYPE> | [FormModelField<TYPE>, ...any[]]

表单项的集合, 用于描述表单的结构. 接受两种类型的参数: FormModelField 和 [FormModelField, ...args].

Example

FormModelField
{
 name: "username",
 label: "用户名",
 type: "input",
 initialValue: "admin"
 }

Example

[FormModelField, ...args]
[
 {
   name: "username",
   label: "用户名",
   type: "input",
   initialValue: "admin"
 },
 {
   maxlength: 11
 }
]

Type parameters ​

Defined in ​

dist/src/components/form-helper/form-helper.d.ts:129

LoadSelectOptionsFunction ​

LoadSelectOptionsFunction<RECORD_TYPE>: (pagination: TablePaginationParams, filter: TableFilterParams, sort: TableSortParams[], extra: { abortSignal: AbortSignal }) => Promise<LoadTableRecordFunctionResult<RECORD_TYPE>>

Type parameters ​

Type declaration ​

(pagination, filter, sort, extra): Promise<LoadTableRecordFunctionResult<RECORD_TYPE>>

加载记录的函数, 用于 AutoLoadSelectHelper 的构造函数.

Parameters ​

Returns ​

Promise<LoadTableRecordFunctionResult<RECORD_TYPE>>

返回值为 LoadTableRecordFunctionResult

Defined in ​

dist/src/components/n-select/auto-load-select-helper.d.ts:61

NAutoLoadSelectProps ​

NAutoLoadSelectProps: ExtendProps<ReturnType<typeof nAutoLoadSelectProps>, NSelectProps>

Defined in ​

dist/src/components/n-select/select-types.d.ts:62

NBaseFormInstance ​

NBaseFormInstance: ComponentPublicInstance<NBaseFormProps, NBaseFormExpose>

Defined in ​

dist/src/components/n-form/form-types.d.ts:242

NBaseFormProps ​

NBaseFormProps: ExtractPropTypes<ReturnType<typeof nBaseFormProps>>

Defined in ​

dist/src/components/n-form/form-types.d.ts:237

NButtonProps ​

NButtonProps: ExtractPropTypes<ReturnType<typeof nButtonProps>>

Defined in ​

dist/src/components/n-button/button-types.d.ts:27

NDrawerContainerProps ​

NDrawerContainerProps: ExtractPropTypes<ReturnType<typeof nDrawerContainerProps>>

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:51

NDrawerProps ​

NDrawerProps: ExtractPropTypes<ReturnType<typeof nDrawerProps>>

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:32

NDrawerWrapperProps ​

NDrawerWrapperProps: ExtractPropTypes<ReturnType<typeof nDrawerWrapperProps>>

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:9

NEasyFormInstance ​

NEasyFormInstance: ComponentPublicInstance<NEasyFormProps, NEasyFormExpose>

Defined in ​

dist/src/components/n-form/form-types.d.ts:124

NEasyFormProps ​

NEasyFormProps: ExtractPropTypes<ReturnType<typeof nEasyFormProps>>

Defined in ​

dist/src/components/n-form/form-types.d.ts:119

NEasyTableInstance ​

NEasyTableInstance: ComponentPublicInstance<NEasyTableProps, NTableExpose>

Defined in ​

dist/src/components/n-table/table-types.d.ts:149

NEasyTableProps ​

NEasyTableProps: ExtractPropTypes<ReturnType<typeof nEasyTableProps>>

Defined in ​

dist/src/components/n-table/table-types.d.ts:148

NFormExpose ​

NFormExpose: NBaseFormExpose

Defined in ​

dist/src/components/n-form/form-types.d.ts:60

NFormInstance ​

NFormInstance: ComponentPublicInstance<NFormProps, NFormExpose>

Defined in ​

dist/src/components/n-form/form-types.d.ts:61

NFormItemProps ​

NFormItemProps: ExtractPropTypes<ReturnType<typeof nFormItemProps>>

Defined in ​

dist/src/components/n-form/form-types.d.ts:181

NFormProps ​

NFormProps: ExtractPropTypes<ReturnType<typeof nFormProps>>

Defined in ​

dist/src/components/n-form/form-types.d.ts:59

NInputNumberProps ​

NInputNumberProps: ExtractPropTypes<ReturnType<typeof nInputNumberProps>>

Defined in ​

dist/src/components/n-input-number/input-number-types.d.ts:36

NLoadingButtonProps ​

NLoadingButtonProps: ExtendProps<ReturnType<typeof nLoadingButtonProps>, NButtonProps>

Defined in ​

dist/src/components/n-button/button-types.d.ts:47

NModalContainerProps ​

NModalContainerProps: ExtractPropTypes<ReturnType<typeof nModalContainerProps>>

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:51

NModalProps ​

NModalProps: ExtractPropTypes<ReturnType<typeof nModalProps>>

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:32

NModalWrapperProps ​

NModalWrapperProps: ExtractPropTypes<ReturnType<typeof nModalWrapperProps>>

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:9

NPageLayoutProps ​

NPageLayoutProps: ReturnType<typeof nPageLayoutProps>

Defined in ​

dist/src/components/n-page-layout/page-layout-types.d.ts:8

NPrintBaseCustomPrintFunc ​

NPrintBaseCustomPrintFunc: (props: Readonly<NPrintProps>, element: HTMLElement) => void | Promise<void>

Type declaration ​

(props, element): void | Promise<void>

Parameters ​

Returns ​

void | Promise<void>

Defined in ​

dist/src/components/n-print/print-types.d.ts:180

NPrintBaseExpose ​

NPrintBaseExpose: Object

Type declaration ​

Defined in ​

dist/src/components/n-print/print-types.d.ts:182

NPrintBaseInstance ​

NPrintBaseInstance: ComponentPublicInstance<NPrintBaseProps, NPrintBaseExpose>

Defined in ​

dist/src/components/n-print/print-types.d.ts:185

NPrintBaseProps ​

NPrintBaseProps: ExtractPropTypes<ReturnType<typeof nPrintBaseProps>>

Defined in ​

dist/src/components/n-print/print-types.d.ts:181

NPrintCLodopServiceConfig ​

NPrintCLodopServiceConfig: Object

C-LODOP 打印服务的配置.

Type declaration ​

Defined in ​

dist/src/components/n-print/lodop/lodop-print-types.d.ts:95

NPrintInstance ​

NPrintInstance: ComponentPublicInstance<NPrintProps, NPrintBaseExpose>

Defined in ​

dist/src/components/n-print/print-types.d.ts:186

NPrintLodopCustomPrintFunc ​

NPrintLodopCustomPrintFunc: (props: Readonly<NPrintPageProps>, iframe: HTMLIFrameElement, lodop: any) => void | Promise<void>

Type declaration ​

(props, iframe, lodop): void | Promise<void>

自定义 LODOP 打印逻辑时的参数.

Parameters ​

Returns ​

void | Promise<void>

Defined in ​

dist/src/components/n-print/lodop/lodop-print-types.d.ts:91

NPrintLodopInstance ​

NPrintLodopInstance: ComponentPublicInstance<NPrintProps, NPrintBaseExpose>

Defined in ​

dist/src/components/n-print/lodop/lodop-print-types.d.ts:3

NPrintMargin ​

NPrintMargin: string | NPrintMarginObject

Defined in ​

dist/src/components/n-print/print-types.d.ts:74

NPrintMarginObject ​

NPrintMarginObject: Object

Type declaration ​

Defined in ​

dist/src/components/n-print/print-types.d.ts:68

NPrintPadding ​

NPrintPadding: string | NPrintMarginObject

Defined in ​

dist/src/components/n-print/print-types.d.ts:75

NPrintPageOrientation ​

NPrintPageOrientation: "portrait" | "landscape"

纸张方向, 根据定义:

• portrait: 矩形平面以短边为底边的方向, 即高度大于等于宽度
• landscape: 矩形平面以长边为底边的方向, 即宽度大于高度

See

• https://zhuanlan.zhihu.com/p/19974005
• https://developer.mozilla.org/en-US/docs/Web/CSS/@media/orientation

Defined in ​

dist/src/components/n-print/print-types.d.ts:67

NPrintPageProps ​

NPrintPageProps: ExtractPropTypes<ReturnType<typeof nPrintPageProps>>

Defined in ​

dist/src/components/n-print/print-types.d.ts:119

NPrintPageSize ​

NPrintPageSize: NPrintPresetPageSize | string | [string, string]

Defined in ​

dist/src/components/n-print/print-types.d.ts:58

NPrintPresetPageSize ​

NPrintPresetPageSize: "A5" | "A4" | "A3" | "B5" | "B4" | "JIS-B5" | "JIS-B4" | "letter" | "legal" | "ledger"

Defined in ​

dist/src/components/n-print/print-types.d.ts:57

NPrintProps ​

NPrintProps: ExtractPropTypes<ReturnType<typeof nPrintProps>>

Defined in ​

dist/src/components/n-print/print-types.d.ts:56

NSelectProps ​

NSelectProps: ExtendProps<ReturnType<typeof nSelectProps>, SelectProps>

Defined in ​

dist/src/components/n-select/select-types.d.ts:39

NSpaceProps ​

NSpaceProps: ExtractPropTypes<ReturnType<typeof nSpaceProps>>

Defined in ​

dist/src/components/n-space/space-types.d.ts:8

NSpecProviderProps ​

NSpecProviderProps: Partial<ExtractPropTypes<ReturnType<typeof nSpecProviderProps>>>

Defined in ​

dist/src/components/n-spec-provider/spec-provider-types.d.ts:39

NTableColumn ​

NTableColumn<RECORD_TYPE>: ColumnGroupType<RECORD_TYPE> & ColumnType<RECORD_TYPE> & NTableColumnExtraOptions

Type parameters ​

Defined in ​

dist/src/components/n-table/table-types.d.ts:166

NTableColumnExtraOptions ​

NTableColumnExtraOptions: Object

额外的列选项

Type declaration ​

Defined in ​

dist/src/components/n-table/table-types.d.ts:170

NTableInstance ​

NTableInstance: ComponentPublicInstance<NTableProps, NTableExpose>

Defined in ​

dist/src/components/n-table/table-types.d.ts:137

NTableProps ​

NTableProps: ExtractPropTypes<ReturnType<typeof nTableProps>>

Defined in ​

dist/src/components/n-table/table-types.d.ts:128

NToolbarProps ​

NToolbarProps: ExtractPropTypes<ReturnType<typeof nToolbarProps>>

Defined in ​

dist/src/components/n-toolbar/toolbar-types.d.ts:48

NUploadPictureCardProps ​

NUploadPictureCardProps: ExtendProps<ReturnType<typeof nUploadPictureCardProps>, NUploadProps>

Defined in ​

dist/src/components/n-upload/upload-types.d.ts:44

NUploadProps ​

NUploadProps: ExtendProps<ReturnType<typeof nUploadProps>, UploadProps>

Defined in ​

dist/src/components/n-upload/upload-types.d.ts:19

StorableProps ​

StorableProps: Partial<ExtractPropTypes<ReturnType<typeof storableProps>>>

Defined in ​

dist/src/storage/storage-type.d.ts:19

Variables ​

IGNORE ​

Const IGNORE: "IGNORE"

用于 derive 方法的参数, 用于表示派生出的子缓存对象不需要存储在本地. 即随着页面关闭/刷新存储的数据会消失.

Defined in ​

dist/src/storage/simple-storage.d.ts:42

NAutoLoadSelect ​

Const NAutoLoadSelect: __VLS_WithTemplateSlots<DefineComponent, Partial<Record<NonNullable<string | number>, (_: any) => any>>>

Defined in ​

dist/src/components/n-select/NAutoLoadSelect.vue.d.ts:1

NBaseFormExternalFormDataKey ​

Const NBaseFormExternalFormDataKey: "N_BASE_FORM_EXTERNAL_FORM_DATA_KEY"

为 NFormItem 的插槽提供带有响应式的表单数据.

Defined in ​

dist/src/components/n-form/form-types.d.ts:185

NButton ​

Const NButton: DefineComponent<ExtendProps<{ delay: { default: 250 ; type: NumberConstructor } ; onClick: { type: PropType } ; secondary: { default: false ; type: BooleanConstructor } ; type: { type: PropType } ; warning: { default: false ; type: BooleanConstructor } }, Omit<Partial<ExtractPropTypes>, "type">>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtendProps<{ delay: { default: 250 ; type: NumberConstructor } ; onClick: { type: PropType } ; secondary: { default: false ; type: BooleanConstructor } ; type: { type: PropType } ; warning: { default: false ; type: BooleanConstructor } }, Omit<Partial<ExtractPropTypes>, "type">>>, { icon?: any }>

Defined in ​

dist/src/components/n-button/NButton.vue.d.ts:3

NDrawer ​

Const NDrawer: DefineComponent<Partial<ExtractPropTypes> & Partial<NDrawerProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<ExtractPropTypes> & Partial<NDrawerProps>>, { class?: any ; closeIcon?: any ; extra?: any ; footer?: any ; getContainer?: any ; handle?: any ; level?: any ; title?: any }>

Defined in ​

dist/src/components/n-drawer/NDrawer.vue.d.ts:3

NDrawerContainerProvideKey ​

Const NDrawerContainerProvideKey: "DRAWER_CONTAINER_PROVIDE_KEY"

NDrawerContainer 通过 NDrawerContainerProvideKey 为内部的 NDrawer 提供默认的属性

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:59

NDrawerContextKey ​

Const NDrawerContextKey: "DRAWER_CONTEXT_KEY"

NDrawerContainer 通过 NDrawerContextKey 为下级组件提供操作 NDrawer 的方法. 如 closeDrawer 等

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:63

NDrawerParentTeleportKey ​

Const NDrawerParentTeleportKey: "DRAWER_PARENT_TELEPORT_KEY"

NDrawer 通过 NDrawerParentTeleportKey 为下级的 NDrawer 提供挂载点

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:55

NDrawerWrapper ​

Const NDrawerWrapper: DefineComponent

Defined in ​

dist/src/components/n-drawer/DrawerWrapper.vue.d.ts:1

NDrawerWrapperContextKey ​

Const NDrawerWrapperContextKey: "DRAWER_WRAPPER_CONTEXT_KEY"

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:10

NEasyForm ​

Const NEasyForm: DefineComponent<Partial<ExtractPropTypes> & Partial<{ contextSlots: {} ; data: Record<string, any> ; fieldLayout: NFormFieldLayout ; fieldStatus: Partial<NFormFieldStatus> ; fields: AntDesignVueFormModelFieldArgs[] ; onUpdate:data: (data: Record<string, any>) => void } & { onValidateError?: (error: any) => void } & { data: Record<string, any> ; onUpdate:data: (data: Record<string, any>) => void } & { beforeSearch?: (data: Record<string, any>) => boolean | Promise<boolean> ; defaultExpandRowCount?: number | Partial<{ lg: number ; md: number ; sm: number ; xl: number ; xs: number ; xxl: number ; xxxl: number }> ; onChange?: (data: Record<string, any>) => void ; onReset?: () => void ; onSearch?: () => void }>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<ExtractPropTypes> & Partial<{ contextSlots: {} ; data: Record<string, any> ; fieldLayout: NFormFieldLayout ; fieldStatus: Partial<NFormFieldStatus> ; fields: AntDesignVueFormModelFieldArgs[] ; onUpdate:data: (data: Record<string, any>) => void } & { onValidateError?: (error: any) => void } & { data: Record<string, any> ; onUpdate:data: (data: Record<string, any>) => void } & { beforeSearch?: (data: Record<string, any>) => boolean | Promise<boolean> ; defaultExpandRowCount?: number | Partial<{ lg: number ; md: number ; sm: number ; xl: number ; xs: number ; xxl: number ; xxxl: number }> ; onChange?: (data: Record<string, any>) => void ; onReset?: () => void ; onSearch?: () => void }>>, {}>

Defined in ​

dist/src/components/n-form/NEasyForm.vue.d.ts:2

NEasyTable ​

Const NEasyTable: DefineComponent<TableProps<any> & Partial<{ childrenColumnName: string ; columnConfig: Partial<NTableColumnConfig> ; columns: Partial<NTableColumn>[] ; contextSlots: { bodyEditableCell: ({ text, record, index, column }: { column: NTableColumn ; index: number ; record: TableHelper.RecordType ; text: string }) => any ; bodyEditableCellControl: ({ text, record, index, column }: { column: NTableColumn ; index: number ; record: TableHelper.RecordType ; text: string }) => any } ; dataSource: any[] | undefined ; disabledAdaptiveHeight: boolean ; disabledRowKeys: Key[] ; disabledStorable: boolean ; editByClickRow: boolean ; editable: boolean ; fields: AntDesignVueFormModelFieldArgs[] ; onUpdate:editedRowKey: (data: (Key | undefined)[]) => void ; pagination: false | TablePaginationConfig | undefined ; rowKey: string | GetRowKey | undefined ; showNumberColumn: true | TableColumnType & { startIndex: number } ; size: ButtonSize ; striped: boolean } & { customRow?: GetComponentProps ; editedRowKey?: Key ; onResizeColumn?: (w: number, col: TableColumnType) => void ; rowClassName?: string | RowClassName ; rowSelection?: Partial<NTableRowSelection> ; storageKey?: string } & { columns: Partial<NTableColumn>[] ; tableHelper: AntDesignVueTableHelper } & {}>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<TableProps<any> & Partial<{ childrenColumnName: string ; columnConfig: Partial<NTableColumnConfig> ; columns: Partial<NTableColumn>[] ; contextSlots: { bodyEditableCell: ({ text, record, index, column }: { column: NTableColumn ; index: number ; record: TableHelper.RecordType ; text: string }) => any ; bodyEditableCellControl: ({ text, record, index, column }: { column: NTableColumn ; index: number ; record: TableHelper.RecordType ; text: string }) => any } ; dataSource: any[] | undefined ; disabledAdaptiveHeight: boolean ; disabledRowKeys: Key[] ; disabledStorable: boolean ; editByClickRow: boolean ; editable: boolean ; fields: AntDesignVueFormModelFieldArgs[] ; onUpdate:editedRowKey: (data: (Key | undefined)[]) => void ; pagination: false | TablePaginationConfig | undefined ; rowKey: string | GetRowKey | undefined ; showNumberColumn: true | TableColumnType & { startIndex: number } ; size: ButtonSize ; striped: boolean } & { customRow?: GetComponentProps ; editedRowKey?: Key ; onResizeColumn?: (w: number, col: TableColumnType) => void ; rowClassName?: string | RowClassName ; rowSelection?: Partial<NTableRowSelection> ; storageKey?: string } & { columns: Partial<NTableColumn>[] ; tableHelper: AntDesignVueTableHelper } & {}>>, {}>

Defined in ​

dist/src/components/n-table/NEasyTable.vue.d.ts:3

NForm ​

Const NForm: DefineComponent<Partial<ExtractPropTypes> & Partial<NFormProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<ExtractPropTypes> & Partial<NFormProps>>, {}>

Defined in ​

dist/src/components/n-form/NForm.vue.d.ts:3

NFormItem ​

Const NFormItem: DefineComponent<Partial<NFormItemProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<NFormItemProps>>, {}>

Defined in ​

dist/src/components/n-form/NFormItem.vue.d.ts:3

NGanttTable ​

Const NGanttTable: DefineComponent<TableProps<any> & Partial<NGanttTableProps> & Partial<NTableProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<TableProps<any> & Partial<NGanttTableProps> & Partial<NTableProps>>, {}>

Defined in ​

dist/src/components/n-table/n-gantt-table/NGanttTable.vue.d.ts:5

NGanttTableBar ​

Const NGanttTableBar: DefineComponent<Partial<NGanttBarProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<NGanttBarProps>>, {}>

Defined in ​

dist/src/components/n-table/n-gantt-table/NGanttTableBar.vue.d.ts:3

NInputNumber ​

Const NInputNumber: DefineComponent<ExtendProps<{ disabledStorable: { type: BooleanConstructor } ; formatter: { type: PropType } ; onUpdate:value: { type: PropType } ; parser: { type: PropType } ; precision: { type: PropType } ; precisionRange: { type: PropType } ; round: { default: true ; type: PropType } ; storageKey: { type: StringConstructor } ; value: { type: PropType } }, Partial<ExtractPropTypes>>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtendProps<{ disabledStorable: { type: BooleanConstructor } ; formatter: { type: PropType } ; onUpdate:value: { type: PropType } ; parser: { type: PropType } ; precision: { type: PropType } ; precisionRange: { type: PropType } ; round: { default: true ; type: PropType } ; storageKey: { type: StringConstructor } ; value: { type: PropType } }, Partial<ExtractPropTypes>>>, { addonAfter?: any ; addonBefore?: any ; prefix?: any }>

Defined in ​

dist/src/components/n-input-number/NInputNumber.vue.d.ts:3

NLoadingButton ​

Const NLoadingButton: DefineComponent<Partial<NLoadingButtonProps> & Omit<Partial<ExtractPropTypes>, "type">, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<NLoadingButtonProps> & Omit<Partial<ExtractPropTypes>, "type">>, { icon?: any }>

Defined in ​

dist/src/components/n-button/NLoadingButton.vue.d.ts:3

NModal ​

Const NModal: DefineComponent<Partial<ExtractPropTypes> & Partial<NModalProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<ExtractPropTypes> & Partial<NModalProps>>, { cancelText?: any ; closeIcon?: any ; footer?: any ; icon?: any ; okText?: any ; title?: any }>

Defined in ​

dist/src/components/n-modal/NModal.vue.d.ts:3

NModalContainerProvideKey ​

Const NModalContainerProvideKey: "MODAL_CONTAINER_PROVIDE_KEY"

NModalContainer 通过 NModalContainerProvideKey 为内部的 NModal 提供默认的属性

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:59

NModalContextKey ​

Const NModalContextKey: "MODAL_CONTEXT_KEY"

NModalContainer 通过 NModalContextKey 为下级组件提供操作 NModal 的方法. 如 closeModal 等

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:63

NModalParentTeleportKey ​

Const NModalParentTeleportKey: "MODAL_PARENT_TELEPORT_KEY"

NModal 通过 NModalParentTeleportKey 为下级的 NModal 提供挂载点

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:55

NModalWrapper ​

Const NModalWrapper: DefineComponent

Defined in ​

dist/src/components/n-modal/ModalWrapper.vue.d.ts:1

NModalWrapperContextKey ​

Const NModalWrapperContextKey: "MODAL_WRAPPER_CONTEXT_KEY"

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:10

NPageLayout ​

Const NPageLayout: DefineComponent

Defined in ​

dist/src/components/n-page-layout/NPageLayout.vue.d.ts:1

NPrint ​

Const NPrint: DefineComponent

Defined in ​

dist/src/components/n-print/NPrint.vue.d.ts:1

NPrintBase ​

Const NPrintBase: DefineComponent

Defined in ​

dist/src/components/n-print/NPrintBase.vue.d.ts:2

NPrintLodop ​

Const NPrintLodop: DefineComponent

Defined in ​

dist/src/components/n-print/lodop/NPrintLodop.vue.d.ts:3

NPrintPage ​

Const NPrintPage: DefineComponent

Defined in ​

dist/src/components/n-print/NPrintPage.vue.d.ts:1

NPrintPagePropsKey ​

Const NPrintPagePropsKey: "PRINT_PAGE_PROPS_KEY"

Defined in ​

dist/src/components/n-print/print-types.d.ts:120

NSelect ​

Const NSelect: DefineComponent

Defined in ​

dist/src/components/n-select/NSelect.vue.d.ts:2

NSpace ​

Const NSpace: DefineComponent<Partial<ExtractPropTypes> & Partial<NSpaceProps>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<Partial<ExtractPropTypes> & Partial<NSpaceProps>>, {}>

Defined in ​

dist/src/components/n-space/NSpace.vue.d.ts:3

NSpecProvideKey ​

Const NSpecProvideKey: "SPEC_PROVIDER_KEY"

Defined in ​

dist/src/components/n-spec-provider/spec-provider-types.d.ts:40

NSpecProvider ​

Const NSpecProvider: DefineComponent

Defined in ​

dist/src/components/n-spec-provider/NSpecProvider.vue.d.ts:1

NTable ​

Const NTable: DefineComponent<ExtendProps<{ childrenColumnName: { default: "children" ; type: PropType } ; columnConfig: { default: () => {} ; type: PropType } ; columns: { default: () => never[] ; type: PropType } ; contextSlots: { default: () => {} ; type: PropType } ; customRow: { type: PropType } ; dataSource: { default: () => never[] ; type: PropType } ; disabledAdaptiveHeight: { default: false ; type: BooleanConstructor } ; disabledRowKeys: { default: () => never[] ; type: PropType } ; disabledStorable: { type: BooleanConstructor } ; editByClickRow: { default: true ; type: BooleanConstructor } ; editable: { default: false ; type: BooleanConstructor } ; editedRowKey: { type: PropType } ; fields: { default: () => never[] ; type: PropType } ; onResizeColumn: { type: PropType } ; onUpdate:editedRowKey: { default: () => void ; type: PropType } ; pagination: { default: true ; type: PropType } ; rowClassName: { type: PropType } ; rowKey: { default: "key" ; type: PropType } ; rowSelection: { type: PropType } ; showNumberColumn: { default: false ; type: PropType } ; size: { default: "small" ; type: PropType } ; storageKey: { type: StringConstructor } ; striped: { default: false ; type: BooleanConstructor } }, TableProps<any>>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtendProps<{ childrenColumnName: { default: "children" ; type: PropType } ; columnConfig: { default: () => {} ; type: PropType } ; columns: { default: () => never[] ; type: PropType } ; contextSlots: { default: () => {} ; type: PropType } ; customRow: { type: PropType } ; dataSource: { default: () => never[] ; type: PropType } ; disabledAdaptiveHeight: { default: false ; type: BooleanConstructor } ; disabledRowKeys: { default: () => never[] ; type: PropType } ; disabledStorable: { type: BooleanConstructor } ; editByClickRow: { default: true ; type: BooleanConstructor } ; editable: { default: false ; type: BooleanConstructor } ; editedRowKey: { type: PropType } ; fields: { default: () => never[] ; type: PropType } ; onResizeColumn: { type: PropType } ; onUpdate:editedRowKey: { default: () => void ; type: PropType } ; pagination: { default: true ; type: PropType } ; rowClassName: { type: PropType } ; rowKey: { default: "key" ; type: PropType } ; rowSelection: { type: PropType } ; showNumberColumn: { default: false ; type: PropType } ; size: { default: "small" ; type: PropType } ; storageKey: { type: StringConstructor } ; striped: { default: false ; type: BooleanConstructor } }, TableProps<any>>>, {}>

Defined in ​

dist/src/components/n-table/NTable.vue.d.ts:7

NToolbar ​

Const NToolbar: DefineComponent

Defined in ​

dist/src/components/n-toolbar/NToolbar.vue.d.ts:2

NUpload ​

Const NUpload: DefineComponent

Defined in ​

dist/src/components/n-upload/NUpload.vue.d.ts:2

NUploadButton ​

Const NUploadButton: DefineComponent

Defined in ​

dist/src/components/n-upload/NUploadButton.vue.d.ts:2

NUploadPictureCard ​

Const NUploadPictureCard: DefineComponent

Defined in ​

dist/src/components/n-upload/NUploadPictureCard.vue.d.ts:2

StorageManager ​

Const StorageManager: SimpleStorageManager

Defined in ​

dist/src/storage/simple-storage.d.ts:47

breakpoints ​

Const breakpoints: readonly ["xs", "sm", "md", "lg", "xl", "xxl", "xxxl"]

Defined in ​

dist/src/components/utils/hooks/use-responsive/break-point.d.ts:1

cacheStorage ​

Const cacheStorage: SimpleStorage

根部的缓存对象, 用于存储所有的缓存数据. 可以派生出子缓存对象.

Defined in ​

dist/src/storage/simple-storage.d.ts:46

default ​

Const default: Object

Type declaration ​

Defined in ​

dist/src/main.d.ts:19

defaultSpecProvider ​

Const defaultSpecProvider: Object

Type declaration ​

Defined in ​

dist/src/components/utils/hooks/use-spec/index.d.ts:2

Functions ​

buildFormItemControl ​

buildFormItemControl<TYPE>(options, ..._args): FormItemControl<TYPE>

Type parameters ​

Parameters ​

Returns ​

FormItemControl<TYPE>

Defined in ​

dist/src/components/n-form/ant-design-vue-adaptive/ant-design-vue-form-item-control.d.ts:13

getMaximumBreakPoint ​

getMaximumBreakPoint(screen): Breakpoint

Parameters ​

Returns ​

Breakpoint

Defined in ​

dist/src/components/utils/hooks/use-responsive/index.d.ts:14

isStorable ​

isStorable(props): boolean

用于判断是否开启本地存储

Parameters ​

Returns ​

boolean

Defined in ​

dist/src/storage/storage-type.d.ts:24

nAutoLoadSelectProps ​

nAutoLoadSelectProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-select/select-types.d.ts:45

nBaseFormProps ​

nBaseFormProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-form/form-types.d.ts:186

nButtonProps ​

nButtonProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-button/button-types.d.ts:3

nDrawerContainerProps ​

nDrawerContainerProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:33

nDrawerProps ​

nDrawerProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:22

nDrawerWrapperProps ​

nDrawerWrapperProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-drawer/drawer-types.d.ts:3

nEasyFormProps ​

nEasyFormProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-form/form-types.d.ts:62

nEasyTableProps ​

nEasyTableProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-table/table-types.d.ts:138

nFormItemProps ​

nFormItemProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-form/form-types.d.ts:157

nFormProps ​

nFormProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-form/form-types.d.ts:8

nInputNumberProps ​

nInputNumberProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-input-number/input-number-types.d.ts:3

nLoadingButtonProps ​

nLoadingButtonProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-button/button-types.d.ts:28

nModalContainerProps ​

nModalContainerProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:33

nModalProps ​

nModalProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:22

nModalWrapperProps ​

nModalWrapperProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-modal/modal-types.d.ts:3

nPageLayoutProps ​

nPageLayoutProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-page-layout/page-layout-types.d.ts:2

nPrintBaseProps ​

nPrintBaseProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-print/print-types.d.ts:121

nPrintLodopProps ​

nPrintLodopProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-print/lodop/lodop-print-types.d.ts:4

nPrintPageProps ​

nPrintPageProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-print/print-types.d.ts:93

nPrintProps ​

nPrintProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-print/print-types.d.ts:3

nSelectProps ​

nSelectProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-select/select-types.d.ts:7

nSpaceProps ​

nSpaceProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-space/space-types.d.ts:2

nSpecProviderProps ​

nSpecProviderProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-spec-provider/spec-provider-types.d.ts:6

nTableProps ​

nTableProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-table/table-types.d.ts:7

nToolbarProps ​

nToolbarProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-toolbar/toolbar-types.d.ts:3

nUploadPictureCardProps ​

nUploadPictureCardProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-upload/upload-types.d.ts:39

nUploadProps ​

nUploadProps(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-upload/upload-types.d.ts:4

storableProps ​

storableProps(): Object

提供给支持本地存储的组件使用的 props.

Returns ​

Object

Defined in ​

dist/src/storage/storage-type.d.ts:5

useAntDesignVueFormHelper ​

useAntDesignVueFormHelper(onChange, onValidateError, presets, formValidator): Object

Parameters ​

Returns ​

Object

Defined in ​

dist/src/components/n-form/ant-design-vue-adaptive/use-ant-design-vue-form-helper.d.ts:3

useAntDesignVueTableHelper ​

useAntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>(loadRecord, columns, recordKeyName, options?): Object

易于使用的 Ant Design Vue TableHelper hook.

Type parameters ​

Parameters ​

Returns ​

Object

Defined in ​

dist/src/components/n-table/use-ant-design-vue-table-helper.d.ts:12

useAutoLoadSelectHelper ​

useAutoLoadSelectHelper(loadRecord, recordKeyName, options?): Object

Parameters ​

Returns ​

Object

Defined in ​

dist/src/components/n-select/auto-load-select-helper.d.ts:10

useDrawer ​

useDrawer(): NDrawerContext

导出用于操作当前 NDrawer 的方法.

Returns ​

NDrawerContext

Defined in ​

dist/src/components/n-drawer/use-drawer.d.ts:5

useDrawerManager ​

useDrawerManager(): NDrawerWrapperContext

Returns ​

NDrawerWrapperContext

Defined in ​

dist/src/components/n-drawer/use-drawer.d.ts:6

useModal ​

useModal(): NModalContext

导出用于操作当前 NModal 的方法.

Returns ​

NModalContext

Defined in ​

dist/src/components/n-modal/use-modal.d.ts:5

useModalManager ​

useModalManager(): NModalWrapperContext

Returns ​

NModalWrapperContext

Defined in ​

dist/src/components/n-modal/use-modal.d.ts:6

useNDrawerWrapper ​

useNDrawerWrapper(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-drawer/use-drawer-wrapper.d.ts:2

useNModalWrapper ​

useNModalWrapper(): Object

Returns ​

Object

Defined in ​

dist/src/components/n-modal/use-modal-wrapper.d.ts:2

useResponsive ​

useResponsive(): Object