mirror of
https://github.com/alibaba/lowcode-engine.git
synced 2026-03-10 09:56:20 +00:00
521 KiB
521 KiB
Snapshot report for test/index.ts
The actual snapshot is saved in index.ts.snap.
Generated by AVA.
antd component by local
Snapshot 1
[
{
componentName: 'Affix',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Affix',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
description: '距离窗口顶部达到指定偏移量后触发',
name: 'offsetTop',
propType: 'number',
},
{
description: '距离窗口底部达到指定偏移量后触发',
name: 'offsetBottom',
propType: 'number',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
description: '固定状态改变时触发的回调函数',
name: 'onChange',
propType: 'function',
},
{
defaultValue: undefined,
description: '设置 Affix 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数',
name: 'target',
propType: 'function',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: {
isRequired: true,
type: 'node',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Anchor',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Anchor',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
defaultValue: true,
name: 'affix',
},
{
defaultValue: false,
name: 'showInkInFixed',
},
{
defaultValue: undefined,
name: 'getContainer',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'AnchorLink',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Anchor',
main: 'components/index.tsx',
package: 'antd',
subName: 'Link',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
defaultValue: '#',
name: 'href',
propType: 'string',
},
{
name: 'target',
propType: 'string',
},
{
name: 'title',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'children',
propType: 'node',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Alert',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Alert',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
description: 'Type of Alert styles, options:`success`, `info`, `warning`, `error`',
name: 'type',
propType: {
type: 'oneOfType',
value: [
'success',
'info',
'warning',
'error',
],
},
},
{
description: 'Whether Alert can be closed',
name: 'closable',
propType: 'bool',
},
{
description: 'Close text to show',
name: 'closeText',
propType: 'node',
},
{
description: 'Content of Alert',
name: 'message',
propType: {
isRequired: true,
type: 'node',
},
},
{
description: 'Additional content of Alert',
name: 'description',
propType: 'node',
},
{
description: 'Callback when close Alert',
name: 'onClose',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
description: 'Trigger when animation ending of Alert',
name: 'afterClose',
propType: 'function',
},
{
description: 'Whether to show icon',
name: 'showIcon',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'banner',
propType: 'bool',
},
{
name: 'icon',
propType: 'node',
},
{
name: 'onMouseEnter',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onMouseLeave',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'ErrorBoundary',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Alert',
main: 'components/index.tsx',
package: 'antd',
subName: 'ErrorBoundary',
version: '4.1.4',
},
props: [
{
name: 'message',
propType: 'node',
},
{
name: 'description',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Avatar',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Avatar',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 'circle',
description: 'Shape of avatar, options:`circle`, `square`',
name: 'shape',
propType: {
type: 'oneOfType',
value: [
'circle',
'square',
],
},
},
{
defaultValue: 'default',
name: 'size',
propType: {
type: 'oneOfType',
value: [
'large',
'small',
'default',
'number',
],
},
},
{
description: 'Src of image avatar',
name: 'src',
propType: 'string',
},
{
description: 'Srcset of image avatar',
name: 'srcSet',
propType: 'string',
},
{
description: 'icon to be used in avatar',
name: 'icon',
propType: 'node',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'alt',
propType: 'string',
},
{
name: 'onError',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'BackTop',
docUrl: '',
npm: {
destructuring: true,
exportName: 'BackTop',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 400,
name: 'visibilityHeight',
propType: 'number',
},
{
name: 'onClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'target',
propType: 'function',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'visible',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Badge',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Badge',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: null,
description: 'Number to show in badge',
name: 'count',
propType: 'node',
},
{
defaultValue: false,
name: 'showZero',
propType: 'bool',
},
{
defaultValue: 99,
description: 'Max count to show',
name: 'overflowCount',
propType: 'number',
},
{
defaultValue: false,
description: 'whether to show red dot without number',
name: 'dot',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'scrollNumberPrefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'status',
propType: {
type: 'instanceOf',
value: 'PresetStatusColorType',
},
},
{
name: 'color',
propType: {
type: 'instanceOf',
value: 'LiteralUnion',
},
},
{
name: 'text',
propType: 'node',
},
{
name: 'offset',
propType: {
type: 'oneOf',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
],
},
},
{
name: 'title',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Breadcrumb',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Breadcrumb',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'routes',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'params',
propType: 'any',
},
{
defaultValue: '/',
name: 'separator',
propType: 'node',
},
{
name: 'itemRender',
propType: 'function',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'BreadcrumbItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Breadcrumb',
main: 'components/index.tsx',
package: 'antd',
subName: 'Item',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
defaultValue: '/',
name: 'separator',
propType: 'node',
},
{
name: 'href',
propType: 'string',
},
{
name: 'overlay',
propType: {
type: 'instanceOf',
value: 'DropDownProps[\'overlay\']',
},
},
{
name: 'dropdownProps',
propType: {
type: 'instanceOf',
value: 'DropDownProps',
},
},
{
name: 'onClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Button',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Button',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'Group',
propType: {
isRequired: true,
type: 'instanceOf',
value: 'Group',
},
},
{
name: '__ANT_BUTTON',
propType: {
isRequired: true,
type: 'bool',
},
},
{
defaultValue: false,
name: 'loading',
},
{
defaultValue: false,
name: 'ghost',
},
{
defaultValue: false,
name: 'block',
},
{
defaultValue: 'button',
name: 'htmlType',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'ButtonGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Button',
main: 'components/index.tsx',
package: 'antd',
subName: 'Group',
version: '4.1.4',
},
props: [
{
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'prefixCls',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Card',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'title',
propType: 'node',
},
{
name: 'extra',
propType: 'node',
},
{
name: 'bordered',
propType: 'bool',
},
{
name: 'headStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'bodyStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'loading',
propType: 'bool',
},
{
name: 'hoverable',
propType: 'bool',
},
{
name: 'children',
propType: 'node',
},
{
name: 'id',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'default',
'small',
],
},
},
{
name: 'type',
propType: 'inner',
},
{
name: 'cover',
propType: 'node',
},
{
name: 'actions',
propType: 'arrayOf',
},
{
name: 'tabList',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'tabBarExtraContent',
propType: {
type: 'oneOfType',
value: [
'node',
'null',
],
},
},
{
name: 'onTabChange',
propType: 'function',
},
{
name: 'activeTabKey',
propType: 'string',
},
{
name: 'defaultActiveTabKey',
propType: 'string',
},
{
name: 'tabProps',
propType: {
type: 'instanceOf',
value: 'TabsProps',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Grid',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'components/index.tsx',
package: 'antd',
subName: 'Grid',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'hoverable',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Meta',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'components/index.tsx',
package: 'antd',
subName: 'Meta',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'avatar',
propType: 'node',
},
{
name: 'title',
propType: 'node',
},
{
name: 'description',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Collapse',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Collapse',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'activeKey',
propType: {
type: 'oneOfType',
value: [
{
type: 'arrayOf',
value: 'oneOfType',
},
'string',
'number',
],
},
},
{
name: 'defaultActiveKey',
propType: {
type: 'oneOfType',
value: [
{
type: 'arrayOf',
value: 'oneOfType',
},
'string',
'number',
],
},
},
{
description: '手风琴效果',
name: 'accordion',
propType: 'bool',
},
{
name: 'destroyInactivePanel',
propType: 'bool',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: true,
name: 'bordered',
propType: 'bool',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'expandIcon',
propType: 'function',
},
{
defaultValue: 'left',
name: 'expandIconPosition',
propType: {
type: 'oneOfType',
value: [
'left',
'right',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'CollapsePanel',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Collapse',
main: 'components/index.tsx',
package: 'antd',
subName: 'Panel',
version: '4.1.4',
},
props: [
{
name: 'key',
propType: {
isRequired: true,
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
name: 'header',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'showArrow',
propType: 'bool',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'forceRender',
propType: 'bool',
},
{
name: 'id',
propType: 'string',
},
{
name: 'extra',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Carousel',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Carousel',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'effect',
propType: {
type: 'oneOfType',
value: [
'scrollx',
'fade',
],
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'slickGoTo',
propType: 'number',
},
{
name: 'dotPosition',
propType: {
type: 'oneOfType',
value: [
'top',
'bottom',
'left',
'right',
],
},
},
{
name: 'children',
propType: 'node',
},
{
defaultValue: true,
name: 'dots',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
defaultValue: false,
name: 'arrows',
},
{
defaultValue: false,
name: 'draggable',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Cascader',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Cascader',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: [],
description: '可选项数据源',
name: 'options',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '默认的选中项',
name: 'defaultValue',
propType: 'arrayOf',
},
{
description: '指定选中项',
name: 'value',
propType: 'arrayOf',
},
{
description: '选择完成后的回调',
name: 'onChange',
propType: 'function',
},
{
description: '选择后展示的渲染函数',
name: 'displayRender',
propType: 'function',
},
{
description: '自定义样式',
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义浮层类名',
name: 'popupClassName',
propType: 'string',
},
{
description: '浮层预设位置:`bottomLeft` `bottomRight` `topLeft` `topRight`',
name: 'popupPlacement',
propType: 'string',
},
{
description: '输入框占位文本',
name: 'placeholder',
propType: 'string',
},
{
description: '输入框大小,可选 `large` `default` `small`',
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
defaultValue: true,
description: 'whether has border style',
name: 'bordered',
propType: 'bool',
},
{
defaultValue: false,
description: '禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否支持清除',
name: 'allowClear',
propType: 'bool',
},
{
name: 'showSearch',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'ShowSearchType',
},
],
},
},
{
name: 'notFoundContent',
propType: 'node',
},
{
name: 'loadData',
propType: 'function',
},
{
description: '次级菜单的展开方式,可选 \'click\' 和 \'hover\'',
name: 'expandTrigger',
propType: {
type: 'oneOfType',
value: [
'click',
'hover',
],
},
},
{
description: '当此项为 true 时,点选每级菜单选项值都会发生变化',
name: 'changeOnSelect',
propType: 'bool',
},
{
description: '浮层可见变化时回调',
name: 'onPopupVisibleChange',
propType: 'function',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'inputPrefixCls',
propType: 'string',
},
{
name: 'getPopupContainer',
propType: 'function',
},
{
name: 'popupVisible',
propType: 'bool',
},
{
description: 'use this after antd@3.7.0',
name: 'fieldNames',
propType: {
type: 'instanceOf',
value: 'FieldNamesType',
},
},
{
name: 'suffixIcon',
propType: 'node',
},
{
defaultValue: 'slide-up',
name: 'transitionName',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Checkbox',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Checkbox',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'defaultChecked',
propType: 'bool',
},
{
name: 'checked',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onMouseEnter',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onMouseLeave',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onKeyPress',
propType: {
type: 'instanceOf',
value: 'ReactKeyboardEventHandler',
},
},
{
name: 'onKeyDown',
propType: {
type: 'instanceOf',
value: 'ReactKeyboardEventHandler',
},
},
{
name: 'value',
propType: 'any',
},
{
name: 'tabIndex',
propType: 'number',
},
{
name: 'name',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'id',
propType: 'string',
},
{
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: false,
name: 'indeterminate',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'CheckboxGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Checkbox',
main: 'components/index.tsx',
package: 'antd',
subName: 'Group',
version: '4.1.4',
},
props: [
{
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'value',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: [],
name: 'options',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'onChange',
propType: 'func',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'name',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Col',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Col',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'span',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'order',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'offset',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'push',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'pull',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'xs',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'sm',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'md',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'lg',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'xl',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'xxl',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
'string',
],
},
{
type: 'instanceOf',
value: 'ColSize',
},
],
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'flex',
propType: {
type: 'oneOfType',
value: [
'number',
'none',
'auto',
'string',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Comment',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Comment',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
description: 'List of action items rendered below the comment content',
name: 'actions',
propType: 'arrayOf',
},
{
description: 'The element to display as the comment author.',
name: 'author',
propType: 'node',
},
{
description: 'The element to display as the comment avatar - generally an antd Avatar',
name: 'avatar',
propType: 'node',
},
{
description: 'className of comment',
name: 'className',
propType: 'string',
},
{
description: 'The main content of the comment',
name: 'content',
propType: {
isRequired: true,
type: 'node',
},
},
{
description: 'Nested comments should be provided as children of the Comment',
name: 'children',
propType: 'node',
},
{
description: 'Comment prefix defaults to \'.ant-comment\'',
name: 'prefixCls',
propType: 'string',
},
{
description: 'Additional style for the comment',
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
description: 'A datetime element containing the time to be displayed',
name: 'datetime',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'ConfigProvider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'ConfigProvider',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'getPopupContainer',
propType: 'function',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'renderEmpty',
propType: {
type: 'instanceOf',
value: 'RenderEmptyHandler',
},
},
{
name: 'csp',
propType: {
type: 'instanceOf',
value: 'CSPConfig',
},
},
{
name: 'autoInsertSpaceInButton',
propType: 'bool',
},
{
name: 'form',
propType: 'object',
},
{
name: 'locale',
propType: {
type: 'instanceOf',
value: 'Locale',
},
},
{
name: 'pageHeader',
propType: 'object',
},
{
name: 'componentSize',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
name: 'direction',
propType: {
type: 'oneOfType',
value: [
'ltr',
'rtl',
],
},
},
{
name: 'space',
propType: 'object',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Descriptions',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Descriptions',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'bordered',
propType: 'bool',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'middle',
'small',
'default',
],
},
},
{
name: 'children',
propType: 'node',
},
{
name: 'title',
propType: 'node',
},
{
name: 'column',
propType: {
type: 'oneOfType',
value: [
'number',
{
type: 'instanceOf',
value: 'Partial',
},
],
},
},
{
name: 'layout',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
{
defaultValue: true,
name: 'colon',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Divider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Divider',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'type',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
{
name: 'orientation',
propType: {
type: 'oneOfType',
value: [
'left',
'right',
'center',
],
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'dashed',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Dropdown',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Dropdown',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'trigger',
propType: 'arrayOf',
},
{
name: 'overlay',
propType: {
isRequired: true,
type: 'oneOfType',
value: [
'element',
'function',
],
},
},
{
name: 'onVisibleChange',
propType: 'function',
},
{
name: 'visible',
propType: 'bool',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'align',
propType: 'object',
},
{
name: 'getPopupContainer',
propType: 'function',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'transitionName',
propType: 'string',
},
{
name: 'placement',
propType: {
type: 'instanceOf',
value: 'Placements[number]',
},
},
{
name: 'overlayClassName',
propType: 'string',
},
{
name: 'overlayStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'forceRender',
propType: 'bool',
},
{
defaultValue: 0.15,
name: 'mouseEnterDelay',
propType: 'number',
},
{
defaultValue: 0.1,
name: 'mouseLeaveDelay',
propType: 'number',
},
{
name: 'openClassName',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'DropdownButton',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Dropdown',
main: 'components/index.tsx',
package: 'antd',
subName: 'Button',
version: '4.1.4',
},
props: [
{
defaultValue: 'default',
name: 'type',
propType: {
type: 'oneOfType',
value: [
'primary',
'ghost',
'dashed',
],
},
},
{
name: 'htmlType',
propType: {
type: 'instanceOf',
value: 'ButtonHTMLType',
},
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'onClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'icon',
propType: 'node',
},
{
name: 'href',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'title',
propType: 'string',
},
{
name: 'buttonsRender',
propType: 'function',
},
{
defaultValue: 'bottomRight',
name: 'placement',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Drawer',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Drawer',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: true,
name: 'closable',
propType: 'bool',
},
{
name: 'destroyOnClose',
propType: 'bool',
},
{
name: 'forceRender',
propType: 'bool',
},
{
name: 'getContainer',
propType: {
type: 'oneOfType',
value: [
'string',
'element',
'function',
false,
],
},
},
{
defaultValue: true,
name: 'maskClosable',
propType: 'bool',
},
{
defaultValue: true,
name: 'mask',
propType: 'bool',
},
{
name: 'maskStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
description: 'wrapper dom node style of header and body',
name: 'drawerStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'headerStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'bodyStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'title',
propType: 'node',
},
{
name: 'visible',
propType: 'bool',
},
{
defaultValue: 256,
name: 'width',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: 256,
name: 'height',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'zIndex',
propType: 'number',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'push',
propType: 'bool',
},
{
defaultValue: 'right',
name: 'placement',
propType: {
type: 'instanceOf',
value: 'PlacementTypes[number]',
},
},
{
name: 'onClose',
propType: 'function',
},
{
name: 'afterVisibleChange',
propType: 'function',
},
{
name: 'className',
propType: 'string',
},
{
name: 'handler',
propType: 'node',
},
{
defaultValue: true,
name: 'keyboard',
propType: 'bool',
},
{
name: 'footer',
propType: 'node',
},
{
name: 'footerStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: null,
name: 'level',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Empty',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Empty',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'PRESENTED_IMAGE_DEFAULT',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'PRESENTED_IMAGE_SIMPLE',
propType: {
isRequired: true,
type: 'node',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Input',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
defaultValue: 'text',
name: 'type',
propType: {
type: 'instanceOf',
value: 'LiteralUnion',
},
},
{
name: 'onPressEnter',
propType: {
type: 'instanceOf',
value: 'ReactKeyboardEventHandler',
},
},
{
name: 'addonBefore',
propType: 'node',
},
{
name: 'addonAfter',
propType: 'node',
},
{
name: 'prefix',
propType: 'node',
},
{
name: 'suffix',
propType: 'node',
},
{
name: 'allowClear',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Group',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'components/index.tsx',
package: 'antd',
subName: 'Group',
version: '4.1.4',
},
props: [
{
name: 'className',
propType: 'string',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'large',
'small',
'default',
],
},
},
{
name: 'children',
propType: 'node',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'onMouseEnter',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onMouseLeave',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onFocus',
propType: {
type: 'instanceOf',
value: 'ReactFocusEventHandler',
},
},
{
name: 'onBlur',
propType: {
type: 'instanceOf',
value: 'ReactFocusEventHandler',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'compact',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Search',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'components/index.tsx',
package: 'antd',
subName: 'Search',
version: '4.1.4',
},
props: [
{
name: 'inputPrefixCls',
propType: 'string',
},
{
name: 'onSearch',
propType: 'function',
},
{
defaultValue: false,
name: 'enterButton',
propType: 'node',
},
{
name: 'loading',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'TextArea',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'components/index.tsx',
package: 'antd',
subName: 'TextArea',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'autoSize',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'AutoSizeType',
},
],
},
},
{
name: 'onPressEnter',
propType: {
type: 'instanceOf',
value: 'ReactKeyboardEventHandler',
},
},
{
name: 'allowClear',
propType: 'bool',
},
{
name: 'onResize',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Password',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'components/index.tsx',
package: 'antd',
subName: 'Password',
version: '4.1.4',
},
props: [
{
name: 'inputPrefixCls',
propType: 'string',
},
{
defaultValue: 'click',
name: 'action',
propType: 'string',
},
{
defaultValue: true,
name: 'visibilityToggle',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'InputNumber',
docUrl: '',
npm: {
destructuring: true,
exportName: 'InputNumber',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'min',
propType: 'number',
},
{
name: 'max',
propType: 'number',
},
{
name: 'value',
propType: 'number',
},
{
defaultValue: 1,
name: 'step',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
name: 'defaultValue',
propType: 'number',
},
{
name: 'tabIndex',
propType: 'number',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
name: 'formatter',
propType: 'function',
},
{
name: 'parser',
propType: 'function',
},
{
name: 'decimalSeparator',
propType: 'string',
},
{
name: 'placeholder',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'id',
propType: 'string',
},
{
name: 'precision',
propType: 'number',
},
{
name: 'onPressEnter',
propType: {
type: 'instanceOf',
value: 'ReactKeyboardEventHandler',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'List',
docUrl: '',
npm: {
destructuring: true,
exportName: 'List',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: false,
name: 'bordered',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'children',
propType: 'node',
},
{
defaultValue: [],
name: 'dataSource',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'extra',
propType: 'node',
},
{
name: 'grid',
propType: {
type: 'instanceOf',
value: 'ListGridType',
},
},
{
name: 'id',
propType: 'string',
},
{
name: 'itemLayout',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
{
defaultValue: false,
name: 'loading',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'SpinProps',
},
],
},
},
{
name: 'loadMore',
propType: 'node',
},
{
defaultValue: false,
name: 'pagination',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'PaginationConfig',
},
false,
],
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'rowKey',
propType: {
type: 'oneOfType',
value: [
'any',
'string',
],
},
},
{
name: 'renderItem',
propType: 'function',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'small',
'default',
'large',
],
},
},
{
defaultValue: true,
name: 'split',
propType: 'bool',
},
{
name: 'header',
propType: 'node',
},
{
name: 'footer',
propType: 'node',
},
{
name: 'locale',
propType: {
type: 'instanceOf',
value: 'ListLocale',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Item',
docUrl: '',
npm: {
destructuring: true,
exportName: 'List',
main: 'components/index.tsx',
package: 'antd',
subName: 'Item',
version: '4.1.4',
},
props: [
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'extra',
propType: 'node',
},
{
name: 'actions',
propType: 'arrayOf',
},
{
name: 'grid',
propType: {
type: 'instanceOf',
value: 'ListGridType',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Meta',
docUrl: '',
npm: {
destructuring: true,
exportName: 'List',
main: 'components/index.tsx',
package: 'antd',
subName: 'Meta',
version: '4.1.4',
},
props: [
{
name: 'avatar',
propType: 'node',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
name: 'description',
propType: 'node',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'title',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Menu',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'id',
propType: 'string',
},
{
name: 'theme',
propType: {
type: 'instanceOf',
value: 'MenuTheme',
},
},
{
name: 'mode',
propType: {
type: 'oneOfType',
value: [
'vertical',
'vertical-left',
'vertical-right',
'horizontal',
'inline',
],
},
},
{
name: 'selectable',
propType: 'bool',
},
{
name: 'selectedKeys',
propType: 'arrayOf',
},
{
name: 'defaultSelectedKeys',
propType: 'arrayOf',
},
{
name: 'openKeys',
propType: 'arrayOf',
},
{
name: 'defaultOpenKeys',
propType: 'arrayOf',
},
{
name: 'onOpenChange',
propType: 'function',
},
{
name: 'onSelect',
propType: 'function',
},
{
name: 'onDeselect',
propType: 'function',
},
{
name: 'onClick',
propType: 'function',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'openAnimation',
propType: 'string',
},
{
name: 'openTransitionName',
propType: 'string',
},
{
name: 'motion',
propType: {
type: 'instanceOf',
value: 'Object',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'multiple',
propType: 'bool',
},
{
name: 'inlineIndent',
propType: 'number',
},
{
name: 'inlineCollapsed',
propType: 'bool',
},
{
name: 'subMenuCloseDelay',
propType: 'number',
},
{
name: 'subMenuOpenDelay',
propType: 'number',
},
{
name: 'focusable',
propType: 'bool',
},
{
name: 'onMouseEnter',
propType: 'function',
},
{
name: 'getPopupContainer',
propType: 'function',
},
{
name: 'overflowedIndicator',
propType: 'node',
},
{
name: 'forceSubMenuRender',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'MenuItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'components/index.tsx',
package: 'antd',
subName: 'Item',
version: '4.1.4',
},
props: [
{
name: 'rootPrefixCls',
propType: 'string',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'level',
propType: 'number',
},
{
name: 'title',
propType: 'node',
},
{
name: 'children',
propType: 'node',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'onClick',
propType: 'function',
},
{
name: 'onMouseEnter',
propType: 'function',
},
{
name: 'onMouseLeave',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'SubMenu',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'components/index.tsx',
package: 'antd',
subName: 'SubMenu',
version: '4.1.4',
},
props: [
{
name: 'rootPrefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'title',
propType: 'node',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'onTitleClick',
propType: 'function',
},
{
name: 'onTitleMouseEnter',
propType: 'function',
},
{
name: 'onTitleMouseLeave',
propType: 'function',
},
{
name: 'popupOffset',
propType: {
type: 'oneOf',
value: [
'number',
'number',
],
},
},
{
name: 'popupClassName',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Mentions',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Mentions',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'loading',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'PageHeader',
docUrl: '',
npm: {
destructuring: true,
exportName: 'PageHeader',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'backIcon',
propType: 'node',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'title',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'subTitle',
propType: 'node',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'breadcrumb',
propType: {
type: 'instanceOf',
value: 'BreadcrumbProps',
},
},
{
name: 'tags',
propType: {
type: 'oneOfType',
value: [
'element',
'arrayOf',
],
},
},
{
name: 'footer',
propType: 'node',
},
{
name: 'extra',
propType: 'node',
},
{
name: 'avatar',
propType: {
type: 'instanceOf',
value: 'AvatarProps',
},
},
{
name: 'onBack',
propType: 'function',
},
{
name: 'className',
propType: 'string',
},
{
name: 'ghost',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Pagination',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Pagination',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'total',
propType: 'number',
},
{
name: 'defaultCurrent',
propType: 'number',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'current',
propType: 'number',
},
{
name: 'defaultPageSize',
propType: 'number',
},
{
name: 'pageSize',
propType: 'number',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'hideOnSinglePage',
propType: 'bool',
},
{
name: 'showSizeChanger',
propType: 'bool',
},
{
name: 'pageSizeOptions',
propType: 'arrayOf',
},
{
name: 'onShowSizeChange',
propType: 'function',
},
{
name: 'showQuickJumper',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
name: 'showTitle',
propType: 'bool',
},
{
name: 'showTotal',
propType: 'function',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'default',
'small',
],
},
},
{
name: 'responsive',
propType: 'bool',
},
{
name: 'simple',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'locale',
propType: {
type: 'instanceOf',
value: 'Object',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'selectPrefixCls',
propType: 'string',
},
{
name: 'itemRender',
propType: 'function',
},
{
name: 'role',
propType: 'string',
},
{
name: 'showLessItems',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Popconfirm',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Popconfirm',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'title',
propType: {
isRequired: true,
type: 'oneOfType',
value: [
'node',
{
type: 'instanceOf',
value: 'RenderFunction',
},
],
},
},
{
defaultValue: false,
name: 'disabled',
propType: 'bool',
},
{
name: 'onConfirm',
propType: 'function',
},
{
name: 'onCancel',
propType: 'function',
},
{
name: 'okText',
propType: 'node',
},
{
defaultValue: 'primary',
name: 'okType',
propType: {
type: 'instanceOf',
value: 'ButtonType',
},
},
{
name: 'cancelText',
propType: 'node',
},
{
name: 'okButtonProps',
propType: {
type: 'instanceOf',
value: 'NativeButtonProps',
},
},
{
name: 'cancelButtonProps',
propType: {
type: 'instanceOf',
value: 'NativeButtonProps',
},
},
{
name: 'icon',
propType: 'node',
},
{
name: 'onVisibleChange',
propType: 'function',
},
{
defaultValue: 'zoom-big',
name: 'transitionName',
},
{
defaultValue: 'top',
name: 'placement',
},
{
defaultValue: 'click',
name: 'trigger',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Popover',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Popover',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'title',
propType: {
type: 'oneOfType',
value: [
'node',
{
type: 'instanceOf',
value: 'RenderFunction',
},
],
},
},
{
name: 'content',
propType: {
type: 'oneOfType',
value: [
'node',
{
type: 'instanceOf',
value: 'RenderFunction',
},
],
},
},
{
defaultValue: 'top',
name: 'placement',
},
{
defaultValue: 'zoom-big',
name: 'transitionName',
},
{
defaultValue: 'hover',
name: 'trigger',
},
{
defaultValue: 0.1,
name: 'mouseEnterDelay',
},
{
defaultValue: 0.1,
name: 'mouseLeaveDelay',
},
{
defaultValue: undefined,
name: 'overlayStyle',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Progress',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Progress',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 'line',
name: 'type',
propType: {
type: 'instanceOf',
value: 'ProgressTypes[number]',
},
},
{
defaultValue: 0,
name: 'percent',
propType: 'number',
},
{
name: 'successPercent',
propType: 'number',
},
{
name: 'format',
propType: 'function',
},
{
name: 'status',
propType: {
type: 'instanceOf',
value: 'ProgressStatuses[number]',
},
},
{
defaultValue: true,
name: 'showInfo',
propType: 'bool',
},
{
name: 'strokeWidth',
propType: 'number',
},
{
defaultValue: 'round',
name: 'strokeLinecap',
propType: {
type: 'oneOfType',
value: [
'butt',
'square',
'round',
],
},
},
{
name: 'strokeColor',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'intersection',
},
],
},
},
{
defaultValue: null,
name: 'trailColor',
propType: 'string',
},
{
name: 'width',
propType: 'number',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: undefined,
name: 'gapDegree',
propType: 'number',
},
{
name: 'gapPosition',
propType: {
type: 'oneOfType',
value: [
'top',
'bottom',
'left',
'right',
],
},
},
{
defaultValue: 'default',
name: 'size',
propType: {
type: 'oneOfType',
value: [
'default',
'small',
],
},
},
{
name: 'steps',
propType: 'number',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Radio',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Radio',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 'radio',
name: 'type',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'RadioGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Radio',
main: 'components/index.tsx',
package: 'antd',
subName: 'Group',
version: '4.1.4',
},
props: [
{
defaultValue: 'outline',
name: 'buttonStyle',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Rate',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Rate',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'count',
propType: 'number',
},
{
name: 'value',
propType: 'number',
},
{
name: 'defaultValue',
propType: 'number',
},
{
name: 'allowHalf',
propType: 'bool',
},
{
name: 'allowClear',
propType: 'bool',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'tooltips',
propType: 'arrayOf',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onHoverChange',
propType: 'function',
},
{
name: 'character',
propType: 'node',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Result',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Result',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'PRESENTED_IMAGE_404',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'PRESENTED_IMAGE_403',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'PRESENTED_IMAGE_500',
propType: {
isRequired: true,
type: 'node',
},
},
{
defaultValue: 'info',
name: 'status',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Row',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Row',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 0,
name: 'gutter',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOfType',
value: [
'number',
{
type: 'instanceOf',
value: 'Partial',
},
],
},
{
type: 'oneOf',
value: [
{
type: 'oneOfType',
value: [
'number',
{
type: 'instanceOf',
value: 'Partial',
},
],
},
{
type: 'oneOfType',
value: [
'number',
{
type: 'instanceOf',
value: 'Partial',
},
],
},
],
},
],
},
},
{
name: 'align',
propType: {
type: 'instanceOf',
value: 'RowAligns[number]',
},
},
{
name: 'justify',
propType: {
type: 'instanceOf',
value: 'RowJustify[number]',
},
},
{
name: 'prefixCls',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Select',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Select',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'mode',
propType: {
type: 'oneOfType',
value: [
'multiple',
'tags',
],
},
},
{
defaultValue: 'slide-up',
name: 'transitionName',
},
{
defaultValue: 'zoom',
name: 'choiceTransitionName',
},
{
defaultValue: true,
name: 'bordered',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Skeleton',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Skeleton',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'active',
propType: 'bool',
},
{
name: 'loading',
propType: 'bool',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
defaultValue: false,
name: 'avatar',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'SkeletonAvatarProps',
},
'bool',
],
},
},
{
defaultValue: true,
name: 'title',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'SkeletonTitleProps',
},
'bool',
],
},
},
{
defaultValue: true,
name: 'paragraph',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'SkeletonParagraphProps',
},
'bool',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'SkeletonButton',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Skeleton',
main: 'components/index.tsx',
package: 'antd',
subName: 'Button',
version: '4.1.4',
},
props: [
{
defaultValue: 'default',
name: 'size',
propType: {
type: 'oneOfType',
value: [
'large',
'small',
'default',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'SkeletonAvatar',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Skeleton',
main: 'components/index.tsx',
package: 'antd',
subName: 'Avatar',
version: '4.1.4',
},
props: [
{
defaultValue: 'circle',
name: 'shape',
propType: {
type: 'oneOfType',
value: [
'circle',
'square',
],
},
},
{
defaultValue: 'default',
name: 'size',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'SkeletonInput',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Skeleton',
main: 'components/index.tsx',
package: 'antd',
subName: 'Input',
version: '4.1.4',
},
props: [
{
defaultValue: 'default',
name: 'size',
propType: {
type: 'oneOfType',
value: [
'large',
'small',
'default',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Slider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Slider',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'tooltipPrefixCls',
propType: 'string',
},
{
name: 'range',
propType: 'bool',
},
{
name: 'reverse',
propType: 'bool',
},
{
name: 'min',
propType: 'number',
},
{
name: 'max',
propType: 'number',
},
{
name: 'step',
propType: {
type: 'oneOfType',
value: [
'number',
'null',
],
},
},
{
name: 'marks',
propType: {
type: 'instanceOf',
value: 'SliderMarks',
},
},
{
name: 'dots',
propType: 'bool',
},
{
name: 'value',
propType: {
type: 'oneOfType',
value: [
'number',
{
type: 'oneOf',
value: [
'number',
'number',
],
},
],
},
},
{
name: 'defaultValue',
propType: {
type: 'oneOfType',
value: [
'number',
{
type: 'oneOf',
value: [
'number',
'number',
],
},
],
},
},
{
name: 'included',
propType: 'bool',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'vertical',
propType: 'bool',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onAfterChange',
propType: 'function',
},
{
name: 'tipFormatter',
propType: {
type: 'oneOfType',
value: [
'null',
'any',
],
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'id',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'tooltipVisible',
propType: 'bool',
},
{
name: 'tooltipPlacement',
propType: {
type: 'instanceOf',
value: 'TooltipPlacement',
},
},
{
name: 'getTooltipPopupContainer',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Space',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Space',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'SizeType',
},
'number',
],
},
},
{
name: 'direction',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Spin',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Spin',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: true,
name: 'spinning',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: 'default',
name: 'size',
propType: {
type: 'instanceOf',
value: 'SpinSizes[number]',
},
},
{
name: 'tip',
propType: 'string',
},
{
name: 'delay',
propType: 'number',
},
{
defaultValue: '',
name: 'wrapperClassName',
propType: 'string',
},
{
name: 'indicator',
propType: 'element',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Steps',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Steps',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'type',
propType: {
type: 'oneOfType',
value: [
'default',
'navigation',
],
},
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 0,
name: 'current',
propType: 'number',
},
{
name: 'direction',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
{
name: 'iconPrefix',
propType: 'string',
},
{
name: 'initial',
propType: 'number',
},
{
name: 'labelPlacement',
propType: {
type: 'oneOfType',
value: [
'horizontal',
'vertical',
],
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'progressDot',
propType: {
type: 'oneOfType',
value: [
'bool',
'func',
],
},
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'default',
'small',
],
},
},
{
name: 'status',
propType: {
type: 'oneOfType',
value: [
'wait',
'process',
'finish',
'error',
],
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'onChange',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Switch',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Switch',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'small',
'default',
],
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'checked',
propType: 'bool',
},
{
name: 'defaultChecked',
propType: 'bool',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onClick',
propType: 'function',
},
{
name: 'checkedChildren',
propType: 'node',
},
{
name: 'unCheckedChildren',
propType: 'node',
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'loading',
propType: 'bool',
},
{
name: 'autoFocus',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'title',
propType: 'string',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Table',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Table',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'dropdownPrefixCls',
propType: 'string',
},
{
name: 'dataSource',
propType: {
type: 'instanceOf',
value: 'RcTableProps[\'data\']',
},
},
{
name: 'columns',
propType: {
type: 'instanceOf',
value: 'ColumnsType',
},
},
{
name: 'pagination',
propType: {
type: 'oneOfType',
value: [
false,
{
type: 'instanceOf',
value: 'TablePaginationConfig',
},
],
},
},
{
name: 'loading',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'SpinProps',
},
],
},
},
{
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
name: 'bordered',
propType: 'bool',
},
{
name: 'locale',
propType: {
type: 'instanceOf',
value: 'TableLocale',
},
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'rowSelection',
propType: {
type: 'instanceOf',
value: 'TableRowSelection',
},
},
{
name: 'getPopupContainer',
propType: {
type: 'instanceOf',
value: 'GetPopupContainer',
},
},
{
name: 'scroll',
propType: {
type: 'instanceOf',
value: 'intersection',
},
},
{
name: 'sortDirections',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'showSorterTooltip',
propType: 'bool',
},
{
defaultValue: 'key',
name: 'rowKey',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Transfer',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Transfer',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'disabled',
propType: 'bool',
},
{
defaultValue: [],
name: 'dataSource',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'targetKeys',
propType: 'arrayOf',
},
{
name: 'selectedKeys',
propType: 'arrayOf',
},
{
name: 'render',
propType: 'function',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onSelectChange',
propType: 'function',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: Function {},
name: 'listStyle',
propType: {
type: 'oneOfType',
value: [
'any',
{
type: 'instanceOf',
value: 'ReactCSSProperties',
},
],
},
},
{
name: 'operationStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'titles',
propType: 'arrayOf',
},
{
name: 'operations',
propType: 'arrayOf',
},
{
defaultValue: false,
name: 'showSearch',
propType: 'bool',
},
{
name: 'filterOption',
propType: 'function',
},
{
defaultValue: undefined,
name: 'locale',
propType: {
type: 'instanceOf',
value: 'Partial',
},
},
{
name: 'footer',
propType: 'function',
},
{
name: 'rowKey',
propType: 'function',
},
{
name: 'onSearch',
propType: 'function',
},
{
name: 'onScroll',
propType: 'function',
},
{
name: 'children',
propType: 'function',
},
{
name: 'showSelectAll',
propType: 'bool',
},
{
name: 'selectAllLabels',
propType: {
type: 'arrayOf',
value: 'oneOfType',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'TransferList',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Transfer',
main: 'components/index.tsx',
package: 'antd',
subName: 'List',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: {
isRequired: true,
type: 'string',
},
},
{
defaultValue: '',
name: 'titleText',
propType: 'string',
},
{
defaultValue: [],
name: 'dataSource',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'filterOption',
propType: 'function',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'checkedKeys',
propType: {
isRequired: true,
type: 'arrayOf',
},
},
{
name: 'handleFilter',
propType: {
isRequired: true,
type: 'function',
},
},
{
name: 'onItemSelect',
propType: {
isRequired: true,
type: 'function',
},
},
{
name: 'onItemSelectAll',
propType: {
isRequired: true,
type: 'function',
},
},
{
name: 'handleClear',
propType: {
isRequired: true,
type: 'function',
},
},
{
name: 'render',
propType: 'function',
},
{
defaultValue: false,
name: 'showSearch',
propType: 'bool',
},
{
name: 'searchPlaceholder',
propType: {
isRequired: true,
type: 'string',
},
},
{
name: 'notFoundContent',
propType: {
isRequired: true,
type: 'node',
},
},
{
name: 'itemUnit',
propType: {
isRequired: true,
type: 'string',
},
},
{
name: 'itemsUnit',
propType: {
isRequired: true,
type: 'string',
},
},
{
name: 'renderList',
propType: 'function',
},
{
name: 'footer',
propType: 'function',
},
{
name: 'onScroll',
propType: {
isRequired: true,
type: 'function',
},
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'direction',
propType: {
isRequired: true,
type: 'instanceOf',
value: 'TransferDirection',
},
},
{
name: 'showSelectAll',
propType: 'bool',
},
{
name: 'selectAllLabel',
propType: {
type: 'instanceOf',
value: 'SelectAllLabel',
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Operation',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Transfer',
main: 'components/index.tsx',
package: 'antd',
subName: 'Operation',
version: '4.1.4',
},
props: [
{
name: 'className',
propType: 'string',
},
{
defaultValue: '',
name: 'leftArrowText',
propType: 'string',
},
{
defaultValue: '',
name: 'rightArrowText',
propType: 'string',
},
{
name: 'moveToLeft',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'moveToRight',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'leftActive',
propType: 'bool',
},
{
name: 'rightActive',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'disabled',
propType: 'bool',
},
{
name: 'direction',
propType: {
type: 'oneOfType',
value: [
'ltr',
'rtl',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Search',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Transfer',
main: 'components/index.tsx',
package: 'antd',
subName: 'Search',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
defaultValue: '',
name: 'placeholder',
propType: 'string',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'handleClear',
propType: 'function',
},
{
name: 'value',
propType: 'string',
},
{
name: 'disabled',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Tree',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tree',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'showLine',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '是否支持多选',
name: 'multiple',
propType: 'bool',
},
{
description: '是否自动展开父节点',
name: 'autoExpandParent',
propType: 'bool',
},
{
description: 'checkable状态下节点选择完全受控(父子节点选中状态不再关联)',
name: 'checkStrictly',
propType: 'bool',
},
{
defaultValue: false,
description: '是否支持选中',
name: 'checkable',
propType: 'bool',
},
{
description: '是否禁用树',
name: 'disabled',
propType: 'bool',
},
{
description: '默认展开所有树节点',
name: 'defaultExpandAll',
propType: 'bool',
},
{
description: '默认展开对应树节点',
name: 'defaultExpandParent',
propType: 'bool',
},
{
description: '默认展开指定的树节点',
name: 'defaultExpandedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '(受控)展开指定的树节点',
name: 'expandedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '(受控)选中复选框的树节点',
name: 'checkedKeys',
propType: {
type: 'oneOfType',
value: [
{
type: 'arrayOf',
value: 'instanceOf',
},
'object',
],
},
},
{
description: '默认选中复选框的树节点',
name: 'defaultCheckedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '(受控)设置选中的树节点',
name: 'selectedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '默认选中的树节点',
name: 'defaultSelectedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
name: 'selectable',
propType: 'bool',
},
{
description: '点击树节点触发',
name: 'filterAntTreeNode',
propType: 'function',
},
{
name: 'loadedKeys',
propType: {
type: 'arrayOf',
value: 'instanceOf',
},
},
{
description: '设置节点可拖拽(IE>8)',
name: 'draggable',
propType: 'bool',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: false,
name: 'showIcon',
propType: 'bool',
},
{
name: 'icon',
propType: {
type: 'oneOfType',
value: [
'any',
'node',
],
},
},
{
name: 'switcherIcon',
propType: 'element',
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'children',
propType: 'node',
},
{
defaultValue: false,
name: 'blockNode',
propType: 'bool',
},
{
name: 'motion',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'DirectoryTree',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tree',
main: 'components/index.tsx',
package: 'antd',
subName: 'DirectoryTree',
version: '4.1.4',
},
props: [
{
defaultValue: 'click',
name: 'expandAction',
propType: {
type: 'oneOfType',
value: [
false,
'click',
'doubleClick',
],
},
},
{
defaultValue: true,
name: 'showIcon',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'TreeSelect',
docUrl: '',
npm: {
destructuring: true,
exportName: 'TreeSelect',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'suffixIcon',
propType: 'node',
},
{
name: 'size',
propType: {
type: 'instanceOf',
value: 'SizeType',
},
},
{
defaultValue: true,
name: 'bordered',
propType: 'bool',
},
{
defaultValue: 'slide-up',
name: 'transitionName',
},
{
defaultValue: 'zoom',
name: 'choiceTransitionName',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Tabs',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tabs',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'activeKey',
propType: 'string',
},
{
name: 'defaultActiveKey',
propType: 'string',
},
{
defaultValue: false,
name: 'hideAdd',
propType: 'bool',
},
{
name: 'onChange',
propType: 'function',
},
{
name: 'onTabClick',
propType: 'func',
},
{
name: 'onPrevClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'onNextClick',
propType: {
type: 'instanceOf',
value: 'ReactMouseEventHandler',
},
},
{
name: 'tabBarExtraContent',
propType: {
type: 'oneOfType',
value: [
'node',
'null',
],
},
},
{
name: 'tabBarStyle',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'type',
propType: {
type: 'oneOfType',
value: [
'line',
'card',
'editable-card',
],
},
},
{
defaultValue: 'top',
name: 'tabPosition',
propType: {
type: 'oneOfType',
value: [
'top',
'right',
'bottom',
'left',
],
},
},
{
name: 'onEdit',
propType: 'function',
},
{
name: 'size',
propType: {
type: 'oneOfType',
value: [
'large',
'default',
'small',
],
},
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'animated',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
name: 'tabBarGutter',
propType: 'number',
},
{
name: 'renderTabBar',
propType: 'function',
},
{
name: 'destroyInactiveTabPane',
propType: 'bool',
},
{
name: 'keyboard',
propType: 'bool',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Tag',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tag',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'color',
propType: {
type: 'instanceOf',
value: 'LiteralUnion',
},
},
{
defaultValue: false,
name: 'closable',
propType: 'bool',
},
{
name: 'visible',
propType: 'bool',
},
{
name: 'onClose',
propType: 'func',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'icon',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'CheckableTag',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tag',
main: 'components/index.tsx',
package: 'antd',
subName: 'CheckableTag',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'checked',
propType: {
isRequired: true,
type: 'bool',
},
},
{
name: 'onChange',
propType: 'function',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Timeline',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Timeline',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
description: '指定最后一个幽灵节点是否存在或内容',
name: 'pending',
propType: 'node',
},
{
name: 'pendingDot',
propType: 'node',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
defaultValue: false,
name: 'reverse',
propType: 'bool',
},
{
defaultValue: '',
name: 'mode',
propType: {
type: 'oneOfType',
value: [
'left',
'alternate',
'right',
],
},
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'TimelineItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Timeline',
main: 'components/index.tsx',
package: 'antd',
subName: 'Item',
version: '4.1.4',
},
props: [
{
name: 'prefixCls',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 'blue',
name: 'color',
propType: 'string',
},
{
name: 'dot',
propType: 'node',
},
{
defaultValue: false,
name: 'pending',
propType: 'bool',
},
{
defaultValue: '',
name: 'position',
propType: 'string',
},
{
name: 'style',
propType: {
type: 'instanceOf',
value: 'ReactCSSProperties',
},
},
{
name: 'label',
propType: 'node',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Tooltip',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tooltip',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 'top',
name: 'placement',
},
{
defaultValue: 'zoom-big-fast',
name: 'transitionName',
},
{
defaultValue: 0.1,
name: 'mouseEnterDelay',
},
{
defaultValue: 0.1,
name: 'mouseLeaveDelay',
},
{
defaultValue: false,
name: 'arrowPointAtCenter',
},
{
defaultValue: true,
name: 'autoAdjustOverflow',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Upload',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'components/index.tsx',
package: 'antd',
subName: '',
version: '4.1.4',
},
props: [
{
defaultValue: 'select',
name: 'type',
},
{
defaultValue: false,
name: 'multiple',
},
{
defaultValue: '',
name: 'action',
},
{
defaultValue: undefined,
name: 'data',
},
{
defaultValue: '',
name: 'accept',
},
{
name: 'beforeUpload',
},
{
defaultValue: true,
name: 'showUploadList',
},
{
defaultValue: 'text',
name: 'listType',
},
{
defaultValue: '',
name: 'className',
},
{
defaultValue: false,
name: 'disabled',
},
{
defaultValue: true,
name: 'supportServerRender',
},
],
screenshot: '',
title: 'antd',
},
{
componentName: 'Dragger',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'components/index.tsx',
package: 'antd',
subName: 'Dragger',
version: '4.1.4',
},
props: [
{
name: 'height',
propType: 'number',
},
],
screenshot: '',
title: 'antd',
},
]
fusion next component by local
Snapshot 1
[
{
componentName: 'Affix',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Affix',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: Function {},
description: `设置 Affix 需要监听滚动事件的容器元素␊
@return {ReactElement} 目标容器元素的实例`,
name: 'container',
propType: 'func',
},
{
description: '距离窗口顶部达到指定偏移量后触发',
name: 'offsetTop',
propType: 'number',
},
{
description: '距离窗口底部达到制定偏移量后触发',
name: 'offsetBottom',
propType: 'number',
},
{
description: `当元素的样式发生固钉样式变化时触发的回调函数␊
@param {Boolean} affixed 元素是否被固钉`,
name: 'onAffix',
propType: 'func',
},
{
description: `是否启用绝对布局实现 affix␊
@param {Boolean} 是否启用绝对布局`,
name: 'useAbsolute',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Animate',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Animate',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
description: '动画 className',
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'string',
'object',
],
},
},
{
defaultValue: true,
description: '子元素第一次挂载时是否执行动画',
name: 'animationAppear',
propType: 'bool',
},
{
defaultValue: 'div',
description: '包裹子元素的标签',
name: 'component',
propType: 'any',
},
{
defaultValue: true,
description: '是否只有单个子元素,如果有多个子元素,请设置为 false',
name: 'singleMode',
propType: 'bool',
},
{
defaultValue: Function {},
description: `执行第一次挂载动画前触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'beforeAppear',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行第一次挂载动画,添加 xxx-appear-active 类名后触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'onAppear',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行完第一次挂载动画后触发的函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'afterAppear',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行进场动画前触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'beforeEnter',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行进场动画,添加 xxx-enter-active 类名后触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'onEnter',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行完进场动画后触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'afterEnter',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行离场动画前触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'beforeLeave',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行离场动画,添加 xxx-leave-active 类名后触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'onLeave',
propType: 'func',
},
{
defaultValue: Function {},
description: `执行完离场动画后触发的回调函数␊
@param {HTMLElement} node 执行动画的 dom 元素`,
name: 'afterLeave',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Expand',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Animate',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Expand',
version: '1.19.18',
},
props: [
{
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'string',
'object',
],
},
},
{
defaultValue: Function {},
name: 'beforeEnter',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onEnter',
propType: 'func',
},
{
defaultValue: Function {},
name: 'afterEnter',
propType: 'func',
},
{
defaultValue: Function {},
name: 'beforeLeave',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onLeave',
propType: 'func',
},
{
defaultValue: Function {},
name: 'afterLeave',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Badge',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Badge',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
description: '徽章依托的内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 0,
description: '展示的数字,大于 overflowCount 时显示为 ${overflowCount}+,为 0 时默认隐藏',
name: 'count',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: false,
description: '当count为0时,是否显示count',
name: 'showZero',
propType: 'bool',
},
{
description: '自定义节点内容',
name: 'content',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 99,
description: '展示的封顶的数字',
name: 'overflowCount',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: false,
description: '不展示数字,只展示一个小红点',
name: 'dot',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Balloon',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Balloon',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: '浮层的内容',
name: 'children',
propType: 'any',
},
{
defaultValue: 'medium',
name: 'size',
propType: 'string',
},
{
defaultValue: 'normal',
description: '样式类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'normal',
'primary',
],
},
},
{
description: '弹层当前显示的状态',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认显示的状态',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层在显示和隐藏触发的事件␊
@param {Boolean} visible 弹层是否隐藏和显示␊
@param {String} type 触发弹层显示或隐藏的来源, closeClick 表示由自带的关闭按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: false,
description: '弹出层对齐方式, 是否为边缘对齐',
name: 'alignEdge',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示关闭按钮',
name: 'closable',
propType: 'bool',
},
{
defaultValue: 'b',
description: `弹出层位置␊
@enumdesc 上, 右, 下, 左, 上左, 上右, 下左, 下右, 左上, 左下, 右上, 右下 及其 两两组合`,
name: 'align',
propType: {
type: 'oneOf',
value: [
't',
'r',
'b',
'l',
'tl',
'tr',
'bl',
'br',
'lt',
'lb',
'rt',
'rb',
],
},
},
{
defaultValue: [
0,
0,
],
description: `弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量␊
e.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px`,
name: 'offset',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '触发元素',
name: 'trigger',
propType: 'any',
},
{
defaultValue: 'hover',
description: `触发行为␊
鼠标悬浮, 鼠标点击('hover','click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若弹窗内容有复杂交互请使用click`,
name: 'triggerType',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
name: 'onClick',
propType: 'func',
},
{
description: '任何visible为false时会触发的事件',
name: 'onClose',
propType: 'func',
},
{
name: 'onHover',
propType: 'func',
},
{
defaultValue: false,
description: '是否进行自动位置调整',
name: 'needAdjust',
propType: 'bool',
},
{
description: '弹层在触发以后的延时显示, 单位毫秒 ms',
name: 'delay',
propType: 'number',
},
{
description: '浮层关闭后触发的事件, 如果有动画,则在动画结束后触发',
name: 'afterClose',
propType: 'func',
},
{
description: '强制更新定位信息',
name: 'shouldUpdatePosition',
propType: 'bool',
},
{
defaultValue: true,
description: '弹层出现后是否自动focus到内部第一个元素',
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: undefined,
description: '安全节点:对于triggetType为click的浮层,会在点击除了浮层外的其它区域时关闭浮层.safeNode用于添加不触发关闭的节点, 值可以是dom节点的id或者是节点的dom对象',
name: 'safeNode',
propType: 'string',
},
{
defaultValue: null,
description: '用来指定safeNode节点的id,和safeNode配合使用',
name: 'safeId',
propType: 'string',
},
{
description: `配置动画的播放方式␊
@param {String} in 进场动画␊
@param {String} out 出场动画`,
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
defaultValue: false,
description: '弹层的dom节点关闭时是否删除',
name: 'cache',
propType: 'bool',
},
{
description: '指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。',
name: 'popupContainer',
propType: 'any',
},
{
name: 'container',
propType: 'any',
},
{
defaultValue: undefined,
description: '弹层组件style,透传给Popup',
name: 'popupStyle',
propType: 'object',
},
{
defaultValue: '',
description: '弹层组件className,透传给Popup',
name: 'popupClassName',
propType: 'string',
},
{
defaultValue: undefined,
description: '弹层组件属性,透传给Popup',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '弹层id, 传入值才会支持无障碍',
name: 'id',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Tooltip',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Balloon',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Tooltip',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
description: 'tooltip的内容',
name: 'children',
propType: 'any',
},
{
defaultValue: 'b',
description: `弹出层位置␊
@enumdesc 上, 右, 下, 左, 上左, 上右, 下左, 下右, 左上, 左下, 右上, 右下 及其 两两组合`,
name: 'align',
propType: {
type: 'oneOf',
value: [
't',
'r',
'b',
'l',
'tl',
'tr',
'bl',
'br',
'lt',
'lb',
'rt',
'rb',
],
},
},
{
description: '触发元素',
name: 'trigger',
propType: 'any',
},
{
defaultValue: 'hover',
description: `触发行为␊
鼠标悬浮, 鼠标点击('hover', 'click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若有复杂交互,推荐使用triggerType为click的Balloon组件`,
name: 'triggerType',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '弹层组件style,透传给Popup',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层组件className,透传给Popup',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层组件属性,透传给Popup',
name: 'popupProps',
propType: 'object',
},
{
description: '是否pure render',
name: 'pure',
propType: 'bool',
},
{
description: '指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。',
name: 'popupContainer',
propType: 'any',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '弹层id, 传入值才会支持无障碍',
name: 'id',
propType: 'string',
},
{
defaultValue: 0,
description: '如果需要让 Tooltip 内容可被点击,可以设置这个参数,例如 100',
name: 'delay',
propType: 'number',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'BalloonInner',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Balloon',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Inner',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: true,
name: 'closable',
propType: 'bool',
},
{
name: 'children',
propType: 'any',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: false,
name: 'alignEdge',
propType: 'bool',
},
{
name: 'onClose',
propType: 'func',
},
{
name: 'style',
propType: 'any',
},
{
defaultValue: 'b',
name: 'align',
propType: 'string',
},
{
defaultValue: 'normal',
name: 'type',
propType: 'string',
},
{
name: 'isTooltip',
propType: 'bool',
},
{
name: 'locale',
propType: 'object',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Breadcrumb',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Breadcrumb',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '面包屑子节点,需传入 Breadcrumb.Item',
name: 'children',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 100,
description: '面包屑最多显示个数,超出部分会被隐藏, 设置为 auto 会自动根据父元素的宽度适配。',
name: 'maxNode',
propType: {
type: 'oneOfType',
value: [
'number',
{
type: 'oneOf',
value: [
'auto',
],
},
],
},
},
{
description: '分隔符,可以是文本或 Icon',
name: 'separator',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'nav',
description: '设置标签类型',
name: 'component',
propType: {
type: 'oneOfType',
value: [
'string',
'func',
],
},
},
{
name: 'className',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Item',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Breadcrumb',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '面包屑节点链接,如果设置这个属性,则该节点为`<a />` ,否则是`<span />`',
name: 'link',
propType: 'string',
},
{
name: 'activated',
propType: 'bool',
},
{
name: 'separator',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'className',
propType: 'any',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Button',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Button',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: 'normal',
description: '按钮的类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'primary',
'secondary',
'normal',
],
},
},
{
defaultValue: 'medium',
description: '按钮的尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '按钮中 Icon 的尺寸,用于替代 Icon 的默认大小',
name: 'iconSize',
propType: {
type: 'oneOf',
value: [
'xxs',
'xs',
'small',
'medium',
'large',
'xl',
'xxl',
'xxxl',
],
},
},
{
defaultValue: 'button',
description: '当 component = \'button\' 时,设置 button 标签的 type 值',
name: 'htmlType',
propType: {
type: 'oneOf',
value: [
'submit',
'reset',
'button',
],
},
},
{
defaultValue: 'button',
description: '设置标签类型',
name: 'component',
propType: {
type: 'oneOf',
value: [
'button',
'a',
'div',
'span',
],
},
},
{
defaultValue: false,
description: '设置按钮的载入状态',
name: 'loading',
propType: 'bool',
},
{
defaultValue: false,
description: '是否为幽灵按钮',
name: 'ghost',
propType: {
type: 'oneOf',
value: [
true,
false,
'light',
'dark',
],
},
},
{
defaultValue: false,
description: '是否为文本按钮',
name: 'text',
propType: 'bool',
},
{
defaultValue: false,
description: '是否为警告按钮',
name: 'warning',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: Function {},
description: `点击按钮的回调␊
@param {Object} e Event Object`,
name: 'onClick',
propType: 'func',
},
{
name: 'className',
propType: 'string',
},
{
name: 'onMouseUp',
propType: 'func',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'ButtonGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Button',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'medium',
description: '统一设置 Button 组件的按钮大小',
name: 'size',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Calendar',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Calendar',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '默认选中的日期(moment 对象)',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '选中的日期值 (moment 对象)',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
name: 'modes',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: false,
name: 'disableChangeMode',
propType: 'bool',
},
{
defaultValue: 'YYYY-MM-DD',
name: 'format',
propType: 'string',
},
{
defaultValue: true,
description: '是否展示非本月的日期',
name: 'showOtherMonth',
propType: 'bool',
},
{
description: '默认展示的月份',
name: 'defaultVisibleMonth',
propType: 'func',
},
{
defaultValue: 'fullscreen',
description: '展现形态',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'card',
'fullscreen',
'panel',
],
},
},
{
description: `选择日期单元格时的回调␊
@param {Object} value 对应的日期值 (moment 对象)`,
name: 'onSelect',
propType: 'func',
},
{
description: `面板模式变化时的回调␊
@param {String} mode 对应面板模式 date month year`,
name: 'onModeChange',
propType: 'func',
},
{
description: `展现的月份变化时的回调␊
@param {Object} value 显示的月份 (moment 对象)␊
@param {String} reason 触发月份改变原因`,
name: 'onVisibleMonthChange',
propType: 'func',
},
{
description: '自定义样式类',
name: 'className',
propType: 'string',
},
{
defaultValue: Function {},
description: `自定义日期渲染函数␊
@param {Object} value 日期值(moment对象)␊
@returns {ReactNode}`,
name: 'dateCellRender',
propType: 'func',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
description: `不可选择的日期␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@returns {Boolean}`,
name: 'disabledDate',
propType: 'func',
},
{
description: '国际化配置',
name: 'locale',
propType: 'object',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'RangeCalendar',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Calendar',
main: 'src/index.js',
package: '@alifd/next',
subName: 'RangeCalendar',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '默认的开始日期',
name: 'defaultStartValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '默认的结束日期',
name: 'defaultEndValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '开始日期(moment 对象)',
name: 'startValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '结束日期(moment 对象)',
name: 'endValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: false,
name: 'disableChangeMode',
propType: 'bool',
},
{
defaultValue: 'YYYY-MM-DD',
name: 'format',
propType: 'string',
},
{
defaultValue: false,
description: '是否显示非本月的日期',
name: 'showOtherMonth',
propType: 'bool',
},
{
description: '模板展示的月份(起始月份)',
name: 'defaultVisibleMonth',
propType: 'func',
},
{
description: `展现的月份变化时的回调␊
@param {Object} value 显示的月份 (moment 对象)␊
@param {String} reason 触发月份改变原因`,
name: 'onVisibleMonthChange',
propType: 'func',
},
{
description: `不可选择的日期␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@returns {Boolean}`,
name: 'disabledDate',
propType: 'func',
},
{
description: `选择日期单元格时的回调␊
@param {Object} value 对应的日期值 (moment 对象)`,
name: 'onSelect',
propType: 'func',
},
{
defaultValue: Function {},
description: '自定义日期单元格渲染',
name: 'dateCellRender',
propType: 'func',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Card',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '卡片的上的图片 / 视频',
name: 'media',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '卡片的标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '卡片的副标题',
name: 'subTitle',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '卡片操作组,位置在卡片底部',
name: 'actions',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: true,
description: '是否显示标题的项目符号',
name: 'showTitleBullet',
propType: 'bool',
},
{
defaultValue: true,
description: '是否展示头部的分隔线',
name: 'showHeadDivider',
propType: 'bool',
},
{
defaultValue: 120,
description: '内容区域的固定高度',
name: 'contentHeight',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
description: '标题区域的用户自定义内容',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否开启自由模式,开启后card 将使用子组件配合使用, 设置此项后 title, subtitle, 等等属性都将失效',
name: 'free',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardHeader',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Header',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '卡片的标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '卡片的副标题',
name: 'subTitle',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '标题区域的用户自定义内容',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardMedia',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Media',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
description: '背景图片地址',
name: 'image',
propType: 'string',
},
{
description: '媒体源文件地址',
name: 'src',
propType: 'string',
},
{
defaultValue: undefined,
name: 'style',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardDivider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Divider',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'hr',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
description: '分割线是否向内缩进',
name: 'inset',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardContent',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Content',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardActions',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Actions',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardBulletHeader',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'BulletHeader',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '卡片的标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '卡片的副标题',
name: 'subTitle',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: true,
description: '是否显示标题的项目符号',
name: 'showTitleBullet',
propType: 'bool',
},
{
description: '标题区域的用户自定义内容',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CardCollaspeContent',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Card',
main: 'src/index.js',
package: '@alifd/next',
subName: 'CollaspeContent',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 120,
description: '内容区域的固定高度',
name: 'contentHeight',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
name: 'locale',
propType: 'object',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Cascader',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Cascader',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: `选中值改变时触发的回调函数␊
@param {String|Array} value 选中的值,单选时返回单个值,多选时返回数组␊
@param {Object|Array} data 选中的数据,包括 value 和 label,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点␊
@param {Object} extra 额外参数␊
@param {Array} extra.selectedPath 单选时选中的数据的路径␊
@param {Boolean} extra.checked 多选时当前的操作是选中还是取消选中␊
@param {Object} extra.currentData 多选时当前操作的数据␊
@param {Array} extra.checkedData 多选时所有被选中的数据␊
@param {Array} extra.indeterminateData 多选时半选的数据`,
name: 'onChange',
propType: 'func',
},
{
name: 'onSelect',
propType: 'func',
},
{
defaultValue: 'click',
description: '展开触发的方式',
name: 'expandTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
description: `展开时触发的回调函数␊
@param {Array} expandedValue 各列展开值的数组`,
name: 'onExpand',
propType: 'func',
},
{
defaultValue: false,
description: '是否开启虚拟滚动',
name: 'useVirtual',
propType: 'bool',
},
{
defaultValue: false,
description: '是否多选',
name: 'multiple',
propType: 'bool',
},
{
defaultValue: false,
description: '单选时是否只能选中叶子节点',
name: 'canOnlySelectLeaf',
propType: 'bool',
},
{
defaultValue: false,
description: '多选时是否只能选中叶子节点',
name: 'canOnlyCheckLeaf',
propType: 'bool',
},
{
defaultValue: false,
description: '父子节点是否选中不关联',
name: 'checkStrictly',
propType: 'bool',
},
{
description: '每列列表样式对象',
name: 'listStyle',
propType: 'object',
},
{
description: '每列列表类名',
name: 'listClassName',
propType: 'string',
},
{
defaultValue: Function {},
description: `每列列表项渲染函数␊
@param {Object} data 数据␊
@return {ReactNode} 列表项内容`,
name: 'itemRender',
propType: 'func',
},
{
description: `异步加载数据函数␊
@param {Object} data 当前点击异步加载的数据␊
@param {Object} source 当前点击数据,source是原始对象`,
name: 'loadData',
propType: 'func',
},
{
name: 'searchValue',
propType: 'string',
},
{
name: 'onBlur',
propType: 'func',
},
{
name: 'filteredPaths',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'filteredListStyle',
propType: 'object',
},
{
name: 'resultRender',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CascaderSelect',
docUrl: '',
npm: {
destructuring: true,
exportName: 'CascaderSelect',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 'medium',
description: '选择框大小',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '选择框占位符',
name: 'placeholder',
propType: 'string',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有下拉箭头',
name: 'hasArrow',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
defaultValue: false,
description: '是否有清除按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '自定义内联 label',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '是否只读,只读模式下可以展开弹层但不能选',
name: 'readOnly',
propType: 'bool',
},
{
description: `选中值改变时触发的回调函数␊
@param {String|Array} value 选中的值,单选时返回单个值,多选时返回数组␊
@param {Object|Array} data 选中的数据,包括 value 和 label,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点␊
@param {Object} extra 额外参数␊
@param {Array} extra.selectedPath 单选时选中的数据的路径␊
@param {Boolean} extra.checked 多选时当前的操作是选中还是取消选中␊
@param {Object} extra.currentData 多选时当前操作的数据␊
@param {Array} extra.checkedData 多选时所有被选中的数据␊
@param {Array} extra.indeterminateData 多选时半选的数据`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '展开触发的方式',
name: 'expandTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: Function {},
name: 'onExpand',
propType: 'func',
},
{
defaultValue: false,
description: '是否开启虚拟滚动',
name: 'useVirtual',
propType: 'bool',
},
{
defaultValue: false,
description: '是否多选',
name: 'multiple',
propType: 'bool',
},
{
defaultValue: false,
description: '是否选中即发生改变, 该属性仅在单选模式下有效',
name: 'changeOnSelect',
propType: 'bool',
},
{
defaultValue: false,
description: '是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效',
name: 'canOnlyCheckLeaf',
propType: 'bool',
},
{
defaultValue: false,
description: '父子节点是否选中不关联',
name: 'checkStrictly',
propType: 'bool',
},
{
description: '每列列表样式对象',
name: 'listStyle',
propType: 'object',
},
{
description: '每列列表类名',
name: 'listClassName',
propType: 'string',
},
{
description: `选择框单选时展示结果的自定义渲染函数␊
@param {Array} label 选中路径的文本数组␊
@return {ReactNode} 渲染在选择框中的内容␊
@default 单选时:labelPath => labelPath.join(' / ');多选时:labelPath => labelPath[labelPath.length - 1]`,
name: 'displayRender',
propType: 'func',
},
{
description: `渲染 item 内容的方法␊
@param {Object} item 渲染节点的item␊
@return {ReactNode} item node`,
name: 'itemRender',
propType: 'func',
},
{
defaultValue: false,
description: '是否显示搜索框',
name: 'showSearch',
propType: 'bool',
},
{
defaultValue: Function {},
description: `自定义搜索函数␊
@param {String} searchValue 搜索的关键字␊
@param {Array} path 节点路径␊
@return {Boolean} 是否匹配␊
@default 根据路径所有节点的文本值模糊匹配`,
name: 'filter',
propType: 'func',
},
{
description: `搜索结果自定义渲染函数␊
@param {String} searchValue 搜索的关键字␊
@param {Array} path 匹配到的节点路径␊
@return {ReactNode} 渲染的内容␊
@default 按照节点文本 a / b / c 的模式渲染`,
name: 'resultRender',
propType: 'func',
},
{
defaultValue: true,
description: '搜索结果列表是否和选择框等宽',
name: 'resultAutoWidth',
propType: 'bool',
},
{
defaultValue: 'Not Found',
description: '无数据时显示内容',
name: 'notFoundContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: `异步加载数据函数␊
@param {Object} data 当前点击异步加载的数据`,
name: 'loadData',
propType: 'func',
},
{
description: '自定义下拉框头部',
name: 'header',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '自定义下拉框底部',
name: 'footer',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '初始下拉框是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: '当前下拉框是否显示',
name: 'visible',
propType: 'bool',
},
{
defaultValue: Function {},
description: `下拉框显示或关闭时触发事件的回调函数␊
@param {Boolean} visible 是否显示␊
@param {String} type 触发显示关闭的操作类型, fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
description: '下拉框自定义样式对象',
name: 'popupStyle',
propType: 'object',
},
{
description: '下拉框样式自定义类名',
name: 'popupClassName',
propType: 'string',
},
{
description: '下拉框挂载的容器节点',
name: 'popupContainer',
propType: 'any',
},
{
defaultValue: undefined,
description: '透传到 Popup 的属性对象',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {Array<data>} value 选择值 { label: , value:}`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Checkbox',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Checkbox',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: 'checkbox id, 挂载在input上',
name: 'id',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: '选中状态',
name: 'checked',
propType: 'bool',
},
{
defaultValue: false,
description: '默认选中状态',
name: 'defaultChecked',
propType: 'bool',
},
{
description: '禁用',
name: 'disabled',
propType: 'bool',
},
{
description: '通过属性配置label,',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: 'Checkbox 的中间状态,只会影响到 Checkbox 的样式,并不影响其 checked 属性',
name: 'indeterminate',
propType: 'bool',
},
{
defaultValue: false,
description: 'Checkbox 的默认中间态,只会影响到 Checkbox 的样式,并不影响其 checked 属性',
name: 'defaultIndeterminate',
propType: 'bool',
},
{
description: `状态变化时触发的事件␊
@param {Boolean} checked 是否选中␊
@param {Event} e Dom 事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: `鼠标进入enter事件␊
@param {Event} e Dom 事件对象`,
name: 'onMouseEnter',
propType: 'func',
},
{
description: `鼠标离开Leave事件␊
@param {Event} e Dom 事件对象`,
name: 'onMouseLeave',
propType: 'func',
},
{
description: 'checkbox 的value',
name: 'value',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
description: 'name',
name: 'name',
propType: 'string',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CheckboxGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Checkbox',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: '整体禁用',
name: 'disabled',
propType: 'bool',
},
{
description: '被选中的值列表',
name: 'value',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'string',
'number',
],
},
},
{
description: '默认被选中的值列表',
name: 'defaultValue',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'string',
'number',
],
},
},
{
defaultValue: Function {},
description: `选中值改变时的事件␊
@param {Array} value 选中项列表␊
@param {Event} e Dom 事件对象`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'hoz',
description: `子项目的排列方式␊
- hoz: 水平排列 (default)␊
- ver: 垂直排列`,
name: 'itemDirection',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Collapse',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Collapse',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
description: '组件接受行内样式',
name: 'style',
propType: 'object',
},
{
description: '使用数据模型构建',
name: 'dataSource',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '默认展开keys',
name: 'defaultExpandedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '受控展开keys',
name: 'expandedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '展开状态发升变化时候的回调',
name: 'onExpand',
propType: 'func',
},
{
description: '所有禁用',
name: 'disabled',
propType: 'bool',
},
{
description: '扩展class',
name: 'className',
propType: 'string',
},
{
defaultValue: false,
description: '手风琴模式,一次只能打开一个',
name: 'accordion',
propType: 'bool',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'id',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Panel',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Collapse',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Panel',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
description: '子组件接受行内样式',
name: 'style',
propType: 'object',
},
{
name: 'children',
propType: 'any',
},
{
defaultValue: false,
name: 'isExpanded',
propType: 'bool',
},
{
description: '是否禁止用户操作',
name: 'disabled',
propType: 'bool',
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '扩展class',
name: 'className',
propType: 'string',
},
{
name: 'onClick',
propType: 'func',
},
{
name: 'id',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'ConfigProvider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'ConfigProvider',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
description: '国际化文案对象,属性为组件的 displayName',
name: 'locale',
propType: 'object',
},
{
defaultValue: false,
description: `是否开启错误捕捉 errorBoundary␊
如需自定义参数,请传入对象 对象接受参数列表如下:␊
␊
fallbackUI `Function(error?: {}, errorInfo?: {}) => Element` 捕获错误后的展示␊
afterCatch `Function(error?: {}, errorInfo?: {})` 捕获错误后的行为, 比如埋点上传`,
name: 'errorBoundary',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
description: '是否开启 Pure Render 模式,会提高性能,但是也会带来副作用',
name: 'pure',
propType: 'bool',
},
{
defaultValue: true,
description: '是否在开发模式下显示组件属性被废弃的 warning 提示',
name: 'warning',
propType: 'bool',
},
{
description: '是否开启 rtl 模式',
name: 'rtl',
propType: 'bool',
},
{
description: '设备类型,针对不同的设备类型组件做出对应的响应式变化',
name: 'device',
propType: {
type: 'oneOf',
value: [
'tablet',
'desktop',
'phone',
],
},
},
{
description: '组件树',
name: 'children',
propType: 'any',
},
{
description: '指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数',
name: 'popupContainer',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'ErrorBoundary',
docUrl: '',
npm: {
destructuring: true,
exportName: 'ConfigProvider',
main: 'src/index.js',
package: '@alifd/next',
subName: 'ErrorBoundary',
version: '1.19.18',
},
props: [
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
description: `捕获错误后的自定义处理, 比如埋点上传␊
@param {Object} error 错误␊
@param {Object} errorInfo 错误详细信息`,
name: 'afterCatch',
propType: 'func',
},
{
description: `捕获错误后的展现 自定义组件␊
@param {Object} error 错误␊
@param {Object} errorInfo 错误详细信息␊
@returns {Element} 捕获错误后的处理`,
name: 'fallbackUI',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'DatePicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'DatePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '输入框内置标签',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'success',
'loading',
'error',
],
},
},
{
description: '输入提示',
name: 'placeholder',
propType: 'string',
},
{
description: `默认展现的月␊
@return {MomentObject} 返回包含指定月份的 moment 对象实例`,
name: 'defaultVisibleMonth',
propType: 'func',
},
{
name: 'onVisibleMonthChange',
propType: 'func',
},
{
description: '日期值(受控)moment 对象',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '初始日期值,moment 对象',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 'YYYY-MM-DD',
description: '日期值的格式(用于限定用户输入和展示)',
name: 'format',
propType: 'string',
},
{
defaultValue: false,
description: '是否使用时间控件,传入 TimePicker 的属性 { defaultValue, format, ... }',
name: 'showTime',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
defaultValue: false,
description: '每次选择日期时是否重置时间(仅在 showTime 开启时有效)',
name: 'resetTime',
propType: 'bool',
},
{
defaultValue: Function {},
description: `禁用日期函数␊
@param {MomentObject} 日期值␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@return {Boolean} 是否禁用`,
name: 'disabledDate',
propType: 'func',
},
{
defaultValue: Function {},
description: `自定义面板页脚␊
@return {Node} 自定义的面板页脚组件`,
name: 'footerRender',
propType: 'func',
},
{
description: `日期值改变时的回调␊
@param {MomentObject|String} value 日期值`,
name: 'onChange',
propType: 'func',
},
{
description: `点击确认按钮时的回调␊
@return {MomentObject|String} 日期值`,
name: 'onOk',
propType: 'func',
},
{
defaultValue: 'medium',
description: '输入框尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '弹层显示状态',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示和隐藏的来源 calendarSelect 表示由日期表盘的选择触发; okBtnClick 表示由确认按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式,具体含义见 OverLay文档',
name: 'popupAlign',
propType: 'string',
},
{
description: `弹层容器␊
@param {Element} target 目标元素␊
@return {Element} 弹层的容器元素`,
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层其他属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '输入框其他属性',
name: 'inputProps',
propType: 'object',
},
{
description: `自定义日期渲染函数␊
@param {Object} value 日期值(moment对象)␊
@returns {ReactNode}`,
name: 'dateCellRender',
propType: 'func',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
description: '日期输入框的 aria-label 属性',
name: 'dateInputAriaLabel',
propType: 'string',
},
{
description: '时间输入框的 aria-label 属性',
name: 'timeInputAriaLabel',
propType: 'string',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {MomentObject} value 日期`,
name: 'renderPreview',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'disableChangeMode',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'RangePicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'DatePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: 'RangePicker',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
defaultValue: 'date',
description: '日期范围类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'date',
'month',
'year',
],
},
},
{
description: `默认展示的起始月份␊
@return {MomentObject} 返回包含指定月份的 moment 对象实例`,
name: 'defaultVisibleMonth',
propType: 'func',
},
{
name: 'onVisibleMonthChange',
propType: 'func',
},
{
description: '日期范围值数组 [moment, moment]',
name: 'value',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '初始的日期范围值数组 [moment, moment]',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: 'YYYY-MM-DD',
description: '日期格式',
name: 'format',
propType: 'string',
},
{
defaultValue: false,
description: '是否使用时间控件,支持传入 TimePicker 的属性',
name: 'showTime',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
defaultValue: false,
description: '每次选择是否重置时间(仅在 showTime 开启时有效)',
name: 'resetTime',
propType: 'bool',
},
{
defaultValue: Function {},
description: `禁用日期函数␊
@param {MomentObject} 日期值␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@return {Boolean} 是否禁用`,
name: 'disabledDate',
propType: 'func',
},
{
defaultValue: Function {},
description: `自定义面板页脚␊
@return {Node} 自定义的面板页脚组件`,
name: 'footerRender',
propType: 'func',
},
{
description: `日期范围值改变时的回调 [ MomentObject|String, MomentObject|String ]␊
@param {Array<MomentObject|String>} value 日期值`,
name: 'onChange',
propType: 'func',
},
{
description: `点击确认按钮时的回调 返回开始时间和结束时间`[ MomentObject|String, MomentObject|String ]`␊
@return {Array} 日期范围`,
name: 'onOk',
propType: 'func',
},
{
description: '输入框内置标签',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'error',
'loading',
'success',
],
},
},
{
defaultValue: 'medium',
description: '输入框尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '弹层显示状态',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示和隐藏的来源 okBtnClick 表示由确认按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式, 具体含义见 OverLay文档',
name: 'popupAlign',
propType: 'string',
},
{
description: `弹层容器␊
@param {Element} target 目标元素␊
@return {Element} 弹层的容器元素`,
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层其他属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '输入框其他属性',
name: 'inputProps',
propType: 'object',
},
{
description: '自定义日期单元格渲染',
name: 'dateCellRender',
propType: 'func',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
description: '开始日期输入框的 aria-label 属性',
name: 'startDateInputAriaLabel',
propType: 'string',
},
{
description: '开始时间输入框的 aria-label 属性',
name: 'startTimeInputAriaLabel',
propType: 'string',
},
{
description: '结束日期输入框的 aria-label 属性',
name: 'endDateInputAriaLabel',
propType: 'string',
},
{
description: '结束时间输入框的 aria-label 属性',
name: 'endTimeInputAriaLabel',
propType: 'string',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {Array<MomentObject, MomentObject>} value 日期区间`,
name: 'renderPreview',
propType: 'func',
},
{
defaultValue: false,
name: 'disableChangeMode',
propType: 'bool',
},
{
name: 'ranges',
propType: 'object',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'MonthPicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'DatePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: 'MonthPicker',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '输入框内置标签',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'success',
'loading',
'error',
],
},
},
{
description: '输入提示',
name: 'placeholder',
propType: 'string',
},
{
description: `默认展现的年␊
@return {MomentObject} 返回包含指定年份的 moment 对象实例`,
name: 'defaultVisibleYear',
propType: 'func',
},
{
description: '日期值(受控)moment 对象',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '初始日期值,moment 对象',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 'YYYY-MM',
description: '日期值的格式(用于限定用户输入和展示)',
name: 'format',
propType: 'string',
},
{
defaultValue: Function {},
description: `禁用日期函数␊
@param {MomentObject} 日期值␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@return {Boolean} 是否禁用`,
name: 'disabledDate',
propType: 'func',
},
{
defaultValue: Function {},
description: `自定义面板页脚␊
@return {Node} 自定义的面板页脚组件`,
name: 'footerRender',
propType: 'func',
},
{
description: `日期值改变时的回调␊
@param {MomentObject|String} value 日期值`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'medium',
description: '输入框尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '弹层显示状态',
name: 'visible',
propType: 'bool',
},
{
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示和隐藏的来源 calendarSelect 表示由日期表盘的选择触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式, 具体含义见 OverLay文档',
name: 'popupAlign',
propType: 'string',
},
{
description: `弹层容器␊
@param {Element} target 目标元素␊
@return {Element} 弹层的容器元素`,
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层其他属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '输入框其他属性',
name: 'inputProps',
propType: 'object',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
description: '日期输入框的 aria-label 属性',
name: 'dateInputAriaLabel',
propType: 'string',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {MomentObject} value 月份`,
name: 'renderPreview',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'YearPicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'DatePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: 'YearPicker',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '输入框内置标签',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'success',
'loading',
'error',
],
},
},
{
description: '输入提示',
name: 'placeholder',
propType: 'string',
},
{
description: '日期值(受控)moment 对象',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '初始日期值,moment 对象',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 'YYYY',
description: '日期值的格式(用于限定用户输入和展示)',
name: 'format',
propType: 'string',
},
{
defaultValue: Function {},
description: `禁用日期函数␊
@param {MomentObject} 日期值␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@return {Boolean} 是否禁用`,
name: 'disabledDate',
propType: 'func',
},
{
defaultValue: Function {},
description: `自定义面板页脚␊
@return {Node} 自定义的面板页脚组件`,
name: 'footerRender',
propType: 'func',
},
{
description: `日期值改变时的回调␊
@param {MomentObject|String} value 日期值`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'medium',
description: '输入框尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '弹层显示状态',
name: 'visible',
propType: 'bool',
},
{
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否显示␊
@param {String} reason 触发弹层显示和隐藏的来源 calendarSelect 表示由日期表盘的选择触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式, 具体含义见 OverLay文档',
name: 'popupAlign',
propType: 'string',
},
{
description: `弹层容器␊
@param {Element} target 目标元素␊
@return {Element} 弹层的容器元素`,
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层其他属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '输入框其他属性',
name: 'inputProps',
propType: 'object',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
description: '日期输入框的 aria-label 属性',
name: 'dateInputAriaLabel',
propType: 'string',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {MomentObject} value 年份`,
name: 'renderPreview',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'WeekPicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'DatePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: 'WeekPicker',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '输入框内置标签',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'success',
'loading',
'error',
],
},
},
{
description: '输入提示',
name: 'placeholder',
propType: 'string',
},
{
description: `默认展现的月␊
@return {MomentObject} 返回包含指定月份的 moment 对象实例`,
name: 'defaultVisibleMonth',
propType: 'func',
},
{
name: 'onVisibleMonthChange',
propType: 'func',
},
{
description: '日期值(受控)moment 对象',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '初始日期值,moment 对象',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 'YYYY-wo',
description: '日期值的格式(用于限定用户输入和展示)',
name: 'format',
propType: 'string',
},
{
defaultValue: Function {},
description: `禁用日期函数␊
@param {MomentObject} 日期值␊
@param {String} view 当前视图类型,year: 年, month: 月, date: 日␊
@return {Boolean} 是否禁用`,
name: 'disabledDate',
propType: 'func',
},
{
defaultValue: Function {},
description: `自定义面板页脚␊
@return {Node} 自定义的面板页脚组件`,
name: 'footerRender',
propType: 'func',
},
{
description: `日期值改变时的回调␊
@param {MomentObject|String} value 日期值`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'medium',
description: '输入框尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '弹层显示状态',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示和隐藏的来源 calendarSelect 表示由日期表盘的选择触发; okBtnClick 表示由确认按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式,具体含义见 OverLay文档',
name: 'popupAlign',
propType: 'string',
},
{
description: `弹层容器␊
@param {Element} target 目标元素␊
@return {Element} 弹层的容器元素`,
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层其他属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '输入框其他属性',
name: 'inputProps',
propType: 'object',
},
{
description: `自定义日期渲染函数␊
@param {Object} value 日期值(moment对象)␊
@returns {ReactNode}`,
name: 'dateCellRender',
propType: 'func',
},
{
description: `自定义月份渲染函数␊
@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象␊
@returns {ReactNode}`,
name: 'monthCellRender',
propType: 'func',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {MomentObject} value 年份`,
name: 'renderPreview',
propType: 'func',
},
{
name: 'yearCellRender',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Dialog',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Dialog',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: false,
description: '是否显示',
name: 'visible',
propType: 'bool',
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: `底部内容,设置为 false,则不进行显示␊
@default [<Button type="primary">确定</Button>, <Button>取消</Button>]`,
name: 'footer',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'node',
},
],
},
},
{
defaultValue: 'right',
description: '底部按钮的对齐方式',
name: 'footerAlign',
propType: {
type: 'oneOf',
value: [
'left',
'center',
'right',
],
},
},
{
defaultValue: [
'ok',
'cancel',
],
description: `指定确定按钮和取消按钮是否存在以及如何排列,<br><br>**可选值**:␊
['ok', 'cancel'](确认取消按钮同时存在,确认按钮在左)␊
['cancel', 'ok'](确认取消按钮同时存在,确认按钮在右)␊
['ok'](只存在确认按钮)␊
['cancel'](只存在取消按钮)`,
name: 'footerActions',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: Function {},
description: `在点击确定按钮时触发的回调函数␊
@param {Object} event 点击事件对象`,
name: 'onOk',
propType: 'func',
},
{
defaultValue: Function {},
description: `在点击取消按钮时触发的回调函数␊
@param {Object} event 点击事件对象`,
name: 'onCancel',
propType: 'func',
},
{
defaultValue: undefined,
description: '应用于确定按钮的属性对象',
name: 'okProps',
propType: 'object',
},
{
defaultValue: undefined,
description: '应用于取消按钮的属性对象',
name: 'cancelProps',
propType: 'object',
},
{
defaultValue: 'esc,close',
description: `控制对话框关闭的方式,值可以为字符串或者布尔值,其中字符串是由以下值组成:␊
**close** 表示点击关闭按钮可以关闭对话框␊
**mask** 表示点击遮罩区域可以关闭对话框␊
**esc** 表示按下 esc 键可以关闭对话框␊
如 'close' 或 'close,esc,mask'␊
如果设置为 true,则以上关闭方式全部生效␊
如果设置为 false,则以上关闭方式全部失效`,
name: 'closeable',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: Function {},
description: `对话框关闭时触发的回调函数␊
@param {String} trigger 关闭触发行为的描述字符串␊
@param {Object} event 关闭时事件对象`,
name: 'onClose',
propType: 'func',
},
{
defaultValue: Function {},
description: '对话框关闭后触发的回调函数, 如果有动画,则在动画结束后触发',
name: 'afterClose',
propType: 'func',
},
{
defaultValue: true,
description: '是否显示遮罩',
name: 'hasMask',
propType: 'bool',
},
{
description: `显示隐藏时动画的播放方式␊
@property {String} in 进场动画␊
@property {String} out 出场动画`,
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
defaultValue: false,
description: '对话框弹出时是否自动获得焦点',
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: 'cc cc',
description: '对话框对齐方式, 具体见Overlay文档',
name: 'align',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: false,
description: '当对话框高度超过浏览器视口高度时,是否显示所有内容而不是出现滚动条以保证对话框完整显示在浏览器视口内,该属性仅在对话框垂直水平居中时生效,即 align 被设置为 \'cc cc\' 时',
name: 'isFullScreen',
propType: 'bool',
},
{
defaultValue: false,
description: '是否在对话框重新渲染时及时更新对话框位置,一般用于对话框高度变化后依然能保证原来的对齐方式',
name: 'shouldUpdatePosition',
propType: 'bool',
},
{
defaultValue: 40,
description: '对话框距离浏览器顶部和底部的最小间距,align 被设置为 \'cc cc\' 并且 isFullScreen 被设置为 true 时不生效',
name: 'minMargin',
propType: 'number',
},
{
defaultValue: undefined,
description: '透传到弹层组件的属性对象',
name: 'overlayProps',
propType: 'object',
},
{
description: `自定义国际化文案对象␊
@property {String} ok 确认按钮文案␊
@property {String} cancel 取消按钮文案`,
name: 'locale',
propType: 'object',
},
{
description: '对话框的高度样式属性',
name: 'height',
propType: 'string',
},
{
name: 'popupContainer',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Inner',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Dialog',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Inner',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'footer',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'node',
},
],
},
},
{
defaultValue: 'right',
name: 'footerAlign',
propType: {
type: 'oneOf',
value: [
'left',
'center',
'right',
],
},
},
{
defaultValue: [
'ok',
'cancel',
],
name: 'footerActions',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: Function {},
name: 'onOk',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onCancel',
propType: 'func',
},
{
defaultValue: undefined,
name: 'okProps',
propType: 'object',
},
{
defaultValue: undefined,
name: 'cancelProps',
propType: 'object',
},
{
defaultValue: true,
name: 'closeable',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'onClose',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
defaultValue: 'dialog',
name: 'role',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'height',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Dropdown',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Dropdown',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '弹层内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '弹层当前是否显示',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层显示或隐藏时触发的回调函数␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
description: '触发弹层显示或者隐藏的元素',
name: 'trigger',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'hover',
description: '触发弹层显示或隐藏的操作类型,可以是 \'click\',\'hover\',或者它们组成的数组,如 [\'hover\', \'click\']',
name: 'triggerType',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: false,
description: '设置此属性,弹层无法显示或隐藏',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: 'tl bl',
description: '弹层相对于触发元素的定位, 详见 Overlay 的定位部分',
name: 'align',
propType: 'string',
},
{
defaultValue: [
0,
0,
],
description: `弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量␊
e.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px`,
name: 'offset',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: 200,
description: '弹层显示或隐藏的延时时间(以毫秒为单位),在 triggerType 被设置为 hover 时生效',
name: 'delay',
propType: 'number',
},
{
description: '弹层打开时是否让其中的元素自动获取焦点',
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: false,
description: '是否显示遮罩',
name: 'hasMask',
propType: 'bool',
},
{
defaultValue: false,
description: '隐藏时是否保留子节点',
name: 'cache',
propType: 'bool',
},
{
description: `配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画␊
@default { in: 'expandInDown', out: 'expandOutUp' }`,
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Drawer',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Drawer',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: null,
name: 'trigger',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
defaultValue: 'click',
name: 'triggerType',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '宽度,仅在 placement是 left right 的时候生效',
name: 'width',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
description: '高度,仅在 placement是 top bottom 的时候生效',
name: 'height',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: true,
description: `控制对话框关闭的方式,值可以为字符串或者布尔值,其中字符串是由以下值组成:␊
**close** 表示点击关闭按钮可以关闭对话框␊
**mask** 表示点击遮罩区域可以关闭对话框␊
**esc** 表示按下 esc 键可以关闭对话框␊
如 'close' 或 'close,esc,mask'␊
如果设置为 true,则以上关闭方式全部生效␊
如果设置为 false,则以上关闭方式全部失效`,
name: 'closeable',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: Function {},
description: `对话框关闭时触发的回调函数␊
@param {String} trigger 关闭触发行为的描述字符串␊
@param {Object} event 关闭时事件对象`,
name: 'onClose',
propType: 'func',
},
{
defaultValue: 'right',
description: '位于页面的位置',
name: 'placement',
propType: {
type: 'oneOf',
value: [
'top',
'right',
'bottom',
'left',
],
},
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: 'header上的样式',
name: 'headerStyle',
propType: 'object',
},
{
description: 'body上的样式',
name: 'bodyStyle',
propType: 'object',
},
{
description: '是否显示',
name: 'visible',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示遮罩',
name: 'hasMask',
propType: 'bool',
},
{
name: 'onVisibleChange',
propType: 'func',
},
{
description: `显示隐藏时动画的播放方式␊
@property {String} in 进场动画␊
@property {String} out 出场动画`,
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
name: 'locale',
propType: 'object',
},
{
name: 'popupContainer',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Inner',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Drawer',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Inner',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: true,
name: 'closeable',
propType: 'bool',
},
{
defaultValue: 'dialog',
name: 'role',
propType: 'string',
},
{
name: 'title',
propType: 'string',
},
{
name: 'placement',
propType: {
type: 'oneOf',
value: [
'top',
'right',
'bottom',
'left',
],
},
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'onClose',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'headerStyle',
propType: 'object',
},
{
name: 'bodyStyle',
propType: 'object',
},
{
name: 'afterClose',
propType: 'func',
},
{
name: 'beforeOpen',
propType: 'func',
},
{
name: 'beforeClose',
propType: 'func',
},
{
name: 'cache',
propType: 'bool',
},
{
name: 'shouldUpdatePosition',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Form',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Form',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
description: '内联表单',
name: 'inline',
propType: 'bool',
},
{
defaultValue: 'medium',
description: `单个 Item 的 size 自定义,优先级高于 Form 的 size, 并且当组件与 Item 一起使用时,组件自身设置 size 属性无效。␊
@enumdesc 大, 中, 小`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'medium',
'small',
],
},
},
{
description: '单个 Item 中表单类组件宽度是否是100%',
name: 'fullWidth',
propType: 'bool',
},
{
defaultValue: 'left',
description: `标签的位置␊
@enumdesc 上, 左, 内`,
name: 'labelAlign',
propType: {
type: 'oneOf',
value: [
'top',
'left',
'inset',
],
},
},
{
description: `标签的左右对齐方式␊
@enumdesc 左, 右`,
name: 'labelTextAlign',
propType: {
type: 'oneOf',
value: [
'left',
'right',
],
},
},
{
description: 'field 实例, 传 false 会禁用 field',
name: 'field',
propType: 'any',
},
{
description: '保存 Form 自动生成的 field 对象',
name: 'saveField',
propType: 'func',
},
{
description: '控制第一级 Item 的 labelCol',
name: 'labelCol',
propType: 'object',
},
{
description: '控制第一级 Item 的 wrapperCol',
name: 'wrapperCol',
propType: 'object',
},
{
defaultValue: undefined,
description: 'form内有 `htmlType="submit"` 的元素的时候会触发',
name: 'onSubmit',
propType: 'func',
},
{
description: '子元素',
name: 'children',
propType: 'any',
},
{
description: '扩展class',
name: 'className',
propType: 'string',
},
{
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
description: '表单数值',
name: 'value',
propType: 'object',
},
{
description: `表单变化回调␊
@param {Object} values 表单数据␊
@param {Object} item 详细␊
@param {String} item.name 变化的组件名␊
@param {String} item.value 变化的数据␊
@param {Object} item.field field 实例`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 'form',
description: '设置标签类型',
name: 'component',
propType: {
type: 'oneOfType',
value: [
'string',
'func',
],
},
},
{
name: 'fieldOptions',
propType: 'object',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: 'desktop',
description: '预设屏幕宽度',
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
{
description: '是否开启内置的响应式布局 (使用ResponsiveGrid)',
name: 'responsive',
propType: 'bool',
},
{
description: '是否开启预览态',
name: 'isPreview',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Item',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Form',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: 'label 标签的文本',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: 'label 标签布局,通 `<Col>` 组件,设置 span offset 值,如 {span: 8, offset: 16},该项仅在垂直表单有效',
name: 'labelCol',
propType: 'object',
},
{
description: '需要为输入控件设置布局样式时,使用该属性,用法同 labelCol',
name: 'wrapperCol',
propType: 'object',
},
{
description: '自定义提示信息,如不设置,则会根据校验规则自动生成.',
name: 'help',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '额外的提示信息,和 help 类似,当需要错误信息和提示文案同时出现时,可以使用这个。 位于错误信息后面',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: `校验状态,如不设置,则会根据校验规则自动生成␊
@enumdesc 失败, 成功, 校验中, 警告`,
name: 'validateState',
propType: {
type: 'oneOf',
value: [
'error',
'success',
'loading',
'warning',
],
},
},
{
defaultValue: false,
description: '配合 validateState 属性使用,是否展示 success/loading 的校验状态图标, 目前只有Input支持',
name: 'hasFeedback',
propType: 'bool',
},
{
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
name: 'id',
propType: 'string',
},
{
description: 'node 或者 function(values)',
name: 'children',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'node',
},
'func',
],
},
},
{
description: '单个 Item 的 size 自定义,优先级高于 Form 的 size, 并且当组件与 Item 一起使用时,组件自身设置 size 属性无效。',
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'small',
'medium',
],
},
},
{
description: '单个 Item 中表单类组件宽度是否是100%',
name: 'fullWidth',
propType: 'bool',
},
{
description: `标签的位置␊
@enumdesc 上, 左, 内`,
name: 'labelAlign',
propType: {
type: 'oneOf',
value: [
'top',
'left',
'inset',
],
},
},
{
description: `标签的左右对齐方式␊
@enumdesc 左, 右`,
name: 'labelTextAlign',
propType: {
type: 'oneOf',
value: [
'left',
'right',
],
},
},
{
description: '扩展class',
name: 'className',
propType: 'string',
},
{
description: '[表单校验] 不能为空',
name: 'required',
propType: 'bool',
},
{
description: 'required 的星号是否显示',
name: 'asterisk',
propType: 'bool',
},
{
description: 'required 自定义错误信息',
name: 'requiredMessage',
propType: 'string',
},
{
description: 'required 自定义触发方式',
name: 'requiredTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '[表单校验] 最小值',
name: 'min',
propType: 'number',
},
{
description: '[表单校验] 最大值',
name: 'max',
propType: 'number',
},
{
description: 'min/max 自定义错误信息',
name: 'minmaxMessage',
propType: 'string',
},
{
description: 'min/max 自定义触发方式',
name: 'minmaxTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '[表单校验] 字符串最小长度 / 数组最小个数',
name: 'minLength',
propType: 'number',
},
{
description: '[表单校验] 字符串最大长度 / 数组最大个数',
name: 'maxLength',
propType: 'number',
},
{
description: 'minLength/maxLength 自定义错误信息',
name: 'minmaxLengthMessage',
propType: 'string',
},
{
description: 'minLength/maxLength 自定义触发方式',
name: 'minmaxLengthTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '[表单校验] 字符串精确长度 / 数组精确个数',
name: 'length',
propType: 'number',
},
{
description: 'length 自定义错误信息',
name: 'lengthMessage',
propType: 'string',
},
{
description: 'length 自定义触发方式',
name: 'lengthTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '正则校验',
name: 'pattern',
propType: 'any',
},
{
description: 'pattern 自定义错误信息',
name: 'patternMessage',
propType: 'string',
},
{
description: 'pattern 自定义触发方式',
name: 'patternTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '[表单校验] 四种常用的 pattern',
name: 'format',
propType: {
type: 'oneOf',
value: [
'number',
'email',
'url',
'tel',
],
},
},
{
description: 'format 自定义错误信息',
name: 'formatMessage',
propType: 'string',
},
{
description: 'format 自定义触发方式',
name: 'formatTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '[表单校验] 自定义校验函数',
name: 'validator',
propType: 'func',
},
{
description: 'validator 自定义触发方式',
name: 'validatorTrigger',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '是否修改数据时自动触发校验',
name: 'autoValidate',
propType: 'bool',
},
{
description: '预设屏幕宽度',
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
{
name: 'responsive',
propType: 'bool',
},
{
description: '在响应式布局模式下,表单项占多少列',
name: 'colSpan',
propType: 'number',
},
{
defaultValue: 100,
description: '在响应式布局下,且label在左边时,label的宽度是多少',
name: 'labelWidth',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
description: '是否开启预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {any} value 根据包裹的组件的 value 类型而决定`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Submit',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Form',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Submit',
version: '1.19.18',
},
props: [
{
description: `点击提交后触发␊
@param {Object} value 数据␊
@param {Object} errors 错误数据␊
@param {class} field 实例`,
name: 'onClick',
propType: 'func',
},
{
description: '是否校验/需要校验的 name 数组',
name: 'validate',
propType: {
type: 'oneOfType',
value: [
'bool',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '自定义 field (在 Form 内不需要设置)',
name: 'field',
propType: 'object',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Reset',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Form',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Reset',
version: '1.19.18',
},
props: [
{
description: '自定义重置的字段',
name: 'names',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '点击提交后触发',
name: 'onClick',
propType: 'func',
},
{
description: '返回默认值',
name: 'toDefault',
propType: 'bool',
},
{
description: '自定义 field (在 Form 内不需要设置)',
name: 'field',
propType: 'object',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Error',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Form',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Error',
version: '1.19.18',
},
props: [
{
description: '表单名',
name: 'name',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '自定义 field (在 Form 内不需要设置)',
name: 'field',
propType: 'object',
},
{
name: 'style',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
description: '自定义错误渲染, 可以是 node 或者 function(errors, state)',
name: 'children',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'node',
},
'func',
],
},
},
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Icon',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Icon',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
description: '指定显示哪种图标',
name: 'type',
propType: 'string',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'medium',
description: `指定图标大小␊
<br/>**可选值**<br/> xxs, xs, small, medium, large, xl, xxl, xxxl, inherit`,
name: 'size',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOf',
value: [
'xxs',
'xs',
'small',
'medium',
'large',
'xl',
'xxl',
'xxxl',
'inherit',
],
},
'number',
],
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
defaultValue: 'next-',
name: 'prefix',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Input',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
description: 'label',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '是否出现clear按钮',
name: 'hasClear',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
description: `状态␊
@enumdesc 错误, 校验中, 成功, 警告`,
name: 'state',
propType: {
type: 'oneOf',
value: [
'error',
'loading',
'success',
'warning',
],
},
},
{
defaultValue: 'medium',
description: `尺寸␊
@enumdesc 小, 中, 大`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '按下回车的回调',
name: 'onPressEnter',
propType: 'func',
},
{
name: 'onClear',
propType: 'func',
},
{
description: '原生type',
name: 'htmlType',
propType: 'string',
},
{
name: 'htmlSize',
propType: 'string',
},
{
description: '水印 (Icon的type类型,和hasClear占用一个地方)',
name: 'hint',
propType: 'string',
},
{
description: '文字前附加内容',
name: 'innerBefore',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '文字后附加内容',
name: 'innerAfter',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框前附加内容',
name: 'addonBefore',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框后附加内容',
name: 'addonAfter',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框前附加文字',
name: 'addonTextBefore',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框后附加文字',
name: 'addonTextAfter',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'off',
description: '(原生input支持)',
name: 'autoComplete',
propType: 'string',
},
{
description: '自动聚焦(原生input支持)',
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'inputRender',
propType: 'func',
},
{
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'innerBeforeClassName',
propType: 'string',
},
{
name: 'innerAfterClassName',
propType: 'string',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Password',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Password',
version: '1.19.18',
},
props: [
{
defaultValue: true,
description: '是否展示切换按钮',
name: 'showToggle',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TextArea',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'src/index.js',
package: '@alifd/next',
subName: 'TextArea',
version: '1.19.18',
},
props: [
{
defaultValue: true,
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
description: `状态␊
@enumdesc 错误`,
name: 'state',
propType: {
type: 'oneOf',
value: [
'error',
'warning',
],
},
},
{
defaultValue: false,
description: '自动高度 true / {minRows: 2, maxRows: 4}',
name: 'autoHeight',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
defaultValue: 4,
description: '多行文本框高度 <br />(不要直接用height设置多行文本框的高度, ie9 10会有兼容性问题)',
name: 'rows',
propType: 'number',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Group',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Input',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框前附加内容',
name: 'addonBefore',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框前附加内容css',
name: 'addonBeforeClassName',
propType: 'string',
},
{
description: '输入框后附加内容',
name: 'addonAfter',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框后额外css',
name: 'addonAfterClassName',
propType: 'string',
},
{
description: 'rtl',
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Loading',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Loading',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
description: '自定义内容',
name: 'tip',
propType: 'any',
},
{
defaultValue: 'bottom',
description: `自定义内容位置␊
@enumdesc 出现在动画右边, 出现在动画下面`,
name: 'tipAlign',
propType: {
type: 'oneOf',
value: [
'right',
'bottom',
],
},
},
{
defaultValue: true,
description: 'loading 状态, 默认 true',
name: 'visible',
propType: 'bool',
},
{
name: 'onVisibleChange',
propType: 'func',
},
{
description: '自定义class',
name: 'className',
propType: 'string',
},
{
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
defaultValue: 'large',
description: `设置动画尺寸␊
@description 仅仅对默认动画效果起作用␊
@enumdesc 大号, 中号`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'medium',
],
},
},
{
description: '自定义动画',
name: 'indicator',
propType: 'any',
},
{
description: '动画颜色',
name: 'color',
propType: 'string',
},
{
description: '全屏展示',
name: 'fullScreen',
propType: 'bool',
},
{
description: '子元素',
name: 'children',
propType: 'any',
},
{
defaultValue: true,
description: 'should loader be displayed inline',
name: 'inline',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: null,
name: 'animate',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Menu',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '菜单项和子菜单',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: Function {},
description: `点击菜单项触发的回调函数␊
@param {String} key 点击的菜单项的 key 值␊
@param {Object} item 点击的菜单项对象␊
@param {Object} event 点击的事件对象`,
name: 'onItemClick',
propType: 'func',
},
{
description: '当前打开的子菜单的 key 值',
name: 'openKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: [],
description: '初始打开的子菜单的 key 值',
name: 'defaultOpenKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: false,
description: '初始展开所有的子菜单,只在 mode 设置为 \'inline\' 以及 openMode 设置为 \'multiple\' 下生效,优先级高于 defaultOpenKeys',
name: 'defaultOpenAll',
propType: 'bool',
},
{
defaultValue: Function {},
description: `打开或关闭子菜单触发的回调函数␊
@param {String} key 打开的所有子菜单的 key 值␊
@param {Object} extra 额外参数␊
@param {String} extra.key 当前操作子菜单的 key 值␊
@param {Boolean} extra.open 是否是打开`,
name: 'onOpen',
propType: 'func',
},
{
defaultValue: 'inline',
description: '子菜单打开的模式',
name: 'mode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
{
defaultValue: 'click',
description: '子菜单打开的触发行为',
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 'multiple',
description: '展开内连子菜单的模式,同时可以展开一个子菜单还是多个子菜单,该属性仅在 mode 为 inline 时生效',
name: 'openMode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
],
},
},
{
defaultValue: 20,
description: '内连子菜单缩进距离',
name: 'inlineIndent',
propType: 'number',
},
{
defaultValue: 'down',
name: 'inlineArrowDirection',
propType: {
type: 'oneOf',
value: [
'down',
'right',
],
},
},
{
defaultValue: false,
description: '是否自动让弹层的宽度和菜单项保持一致,如果弹层的宽度比菜单项小则和菜单项保持一致,如果宽度大于菜单项则不做处理',
name: 'popupAutoWidth',
propType: 'bool',
},
{
defaultValue: 'follow',
description: '弹层的对齐方式',
name: 'popupAlign',
propType: {
type: 'oneOf',
value: [
'follow',
'outside',
],
},
},
{
defaultValue: undefined,
description: '弹层自定义 props',
name: 'popupProps',
propType: {
type: 'oneOfType',
value: [
'object',
'func',
],
},
},
{
description: '弹出子菜单自定义 className',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹出子菜单自定义 style',
name: 'popupStyle',
propType: 'object',
},
{
description: '当前选中菜单项的 key 值',
name: 'selectedKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: [],
description: '初始选中菜单项的 key 值',
name: 'defaultSelectedKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: Function {},
description: `选中或取消选中菜单项触发的回调函数␊
@param {Array} selectedKeys 选中的所有菜单项的值␊
@param {Object} item 选中或取消选中的菜单项␊
@param {Object} extra 额外参数␊
@param {Boolean} extra.select 是否是选中␊
@param {Array} extra.key 菜单项的 key␊
@param {Object} extra.label 菜单项的文本␊
@param {Array} extra.keyPath 菜单项 key 的路径`,
name: 'onSelect',
propType: 'func',
},
{
description: '选中模式,单选还是多选,默认无值,不可选',
name: 'selectMode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
],
},
},
{
defaultValue: false,
description: '是否只能选择第一层菜单项(不能选择子菜单中的菜单项)',
name: 'shallowSelect',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示选中图标,如果设置为 false 需配合配置平台设置选中时的背景色以示区分',
name: 'hasSelectedIcon',
propType: 'bool',
},
{
defaultValue: true,
name: 'labelToggleChecked',
propType: 'bool',
},
{
defaultValue: false,
description: `是否将选中图标居右,仅当 hasSelectedIcon 为true 时生效。␊
注意:SubMenu 上的选中图标一直居左,不受此API控制`,
name: 'isSelectIconRight',
propType: 'bool',
},
{
defaultValue: 'ver',
description: '菜单第一层展示方向',
name: 'direction',
propType: {
type: 'oneOf',
value: [
'ver',
'hoz',
],
},
},
{
defaultValue: 'left',
description: '横向菜单条 item 和 footer 的对齐方向,在 direction 设置为 \'hoz\' 并且 header 存在时生效',
name: 'hozAlign',
propType: {
type: 'oneOf',
value: [
'left',
'right',
],
},
},
{
defaultValue: false,
description: '横向菜单模式下,是否维持在一行,即超出一行折叠成 SubMenu 显示, 仅在 direction=\'hoz\' mode=\'popup\' 时生效',
name: 'hozInLine',
propType: 'bool',
},
{
name: 'renderMore',
propType: 'func',
},
{
description: '自定义菜单头部',
name: 'header',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '自定义菜单尾部',
name: 'footer',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否自动获得焦点',
name: 'autoFocus',
propType: 'bool',
},
{
description: '当前获得焦点的子菜单或菜单项 key 值',
name: 'focusedKey',
propType: 'string',
},
{
defaultValue: true,
name: 'focusable',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'onItemFocus',
propType: 'func',
},
{
name: 'onBlur',
propType: 'func',
},
{
defaultValue: false,
description: '是否开启嵌入式模式,一般用于Layout的布局中,开启后没有默认背景、外层border、box-shadow,可以配合`<Menu style={{lineHeight: \'100px\'}}>` 自定义高度',
name: 'embeddable',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'onItemKeyDown',
propType: 'func',
},
{
defaultValue: true,
name: 'expandAnimation',
propType: 'bool',
},
{
name: 'itemClassName',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'SubMenu',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'SubMenu',
version: '1.19.18',
},
props: [
{
name: '_key',
propType: 'string',
},
{
name: 'root',
propType: 'object',
},
{
name: 'level',
propType: 'number',
},
{
name: 'inlineLevel',
propType: 'number',
},
{
defaultValue: 0,
name: 'groupIndent',
propType: 'number',
},
{
defaultValue: false,
name: 'noIcon',
propType: 'bool',
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否可选,该属性仅在设置 Menu 组件 selectMode 属性后生效',
name: 'selectable',
propType: 'bool',
},
{
description: `子菜单打开方式,如果设置会覆盖 Menu 上的同名属性␊
@default Menu 的 mode 属性值`,
name: 'mode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
{
description: '菜单项或下一级子菜单',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'onMouseEnter',
propType: 'func',
},
{
name: 'onMouseLeave',
propType: 'func',
},
{
name: 'subMenuContentClassName',
propType: 'string',
},
{
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
name: 'align',
propType: {
type: 'oneOf',
value: [
'outside',
'follow',
],
},
},
{
name: 'parentMode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'SelectableItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
name: '_key',
propType: 'string',
},
{
name: 'root',
propType: 'object',
},
{
name: 'selected',
propType: 'bool',
},
{
name: 'onSelect',
propType: 'func',
},
{
name: 'inlineIndent',
propType: 'number',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
description: '帮助文本',
name: 'helper',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '菜单项标签内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'onKeyDown',
propType: 'func',
},
{
name: 'onClick',
propType: 'func',
},
{
defaultValue: true,
name: 'needIndent',
propType: 'bool',
},
{
name: 'hasSelectedIcon',
propType: 'bool',
},
{
name: 'isSelectIconRight',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'CheckboxItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'CheckboxItem',
version: '1.19.18',
},
props: [
{
defaultValue: false,
description: '是否选中',
name: 'checked',
propType: 'bool',
},
{
defaultValue: false,
description: '是否半选中',
name: 'indeterminate',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: Function {},
description: `选中或取消选中触发的回调函数␊
@param {Boolean} checked 是否选中␊
@param {Object} event 选中事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: '帮助文本',
name: 'helper',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '标签内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
name: 'checkboxDisabled',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'RadioItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'RadioItem',
version: '1.19.18',
},
props: [
{
defaultValue: false,
description: '是否选中',
name: 'checked',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: Function {},
description: `选中或取消选中触发的回调函数␊
@param {Boolean} checked 是否选中␊
@param {Object} event 选中事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: '帮助文本',
name: 'helper',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '标签内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'PopupItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'PopupItem',
version: '1.19.18',
},
props: [
{
name: '_key',
propType: 'string',
},
{
name: 'root',
propType: 'object',
},
{
name: 'level',
propType: 'number',
},
{
name: 'hasSubMenu',
propType: 'bool',
},
{
defaultValue: false,
name: 'noIcon',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: false,
name: 'selectable',
propType: 'bool',
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '自定义弹层内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'className',
propType: 'string',
},
{
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
name: 'align',
propType: {
type: 'oneOf',
value: [
'outside',
'follow',
],
},
},
{
name: 'autoWidth',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Group',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
name: 'root',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '菜单项',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'parentMode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Divider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Menu',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Divider',
version: '1.19.18',
},
props: [
{
name: 'root',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'MenuButton',
docUrl: '',
npm: {
destructuring: true,
exportName: 'MenuButton',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '按钮上的文本内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: true,
description: '弹层是否与按钮宽度相同',
name: 'autoWidth',
propType: 'bool',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
description: '弹层容器',
name: 'popupContainer',
propType: 'any',
},
{
description: '弹层展开状态',
name: 'visible',
propType: 'bool',
},
{
description: '弹层默认是否展开',
name: 'defaultVisible',
propType: 'bool',
},
{
description: '弹层在显示和隐藏触发的事件',
name: 'onVisibleChange',
propType: 'func',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层属性透传',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
defaultValue: [],
description: '默认激活的菜单项(用法同 Menu 非受控)',
name: 'defaultSelectedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '激活的菜单项(用法同 Menu 受控)',
name: 'selectedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '菜单的选择模式,同 Menu',
name: 'selectMode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
],
},
},
{
description: '点击菜单项后的回调,同 Menu',
name: 'onItemClick',
propType: 'func',
},
{
description: '选择菜单后的回调,同 Menu',
name: 'onSelect',
propType: 'func',
},
{
defaultValue: undefined,
description: '菜单属性透传',
name: 'menuProps',
propType: 'object',
},
{
name: 'style',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Message',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Message',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
defaultValue: 'success',
description: '反馈类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'success',
'warning',
'error',
'notice',
'help',
'loading',
],
},
},
{
defaultValue: 'inline',
description: '反馈外观',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'inline',
'addon',
'toast',
],
},
},
{
defaultValue: 'medium',
description: '反馈大小',
name: 'size',
propType: {
type: 'oneOf',
value: [
'medium',
'large',
],
},
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: true,
description: '默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: '当前是否显示',
name: 'visible',
propType: 'bool',
},
{
description: '显示的图标类型,会覆盖内部设置的IconType',
name: 'iconType',
propType: 'string',
},
{
defaultValue: false,
description: '显示关闭按钮',
name: 'closeable',
propType: 'bool',
},
{
defaultValue: Function {},
description: '关闭按钮的回调',
name: 'onClose',
propType: 'func',
},
{
defaultValue: Function {},
description: '关闭之后调用的函数',
name: 'afterClose',
propType: 'func',
},
{
defaultValue: true,
description: '是否开启展开收起动画',
name: 'animation',
propType: 'bool',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Nav',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Nav',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
description: '导航项和子导航',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'normal',
description: `导航类型␊
@enumdesc 普通, 主要, 次要, 线形`,
name: 'type',
propType: {
type: 'oneOf',
value: [
'normal',
'primary',
'secondary',
'line',
],
},
},
{
defaultValue: 'ver',
description: `导航布局␊
@enumdesc 水平, 垂直`,
name: 'direction',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 'left',
description: '横向导航条 items 和 footer 的对齐方向,在 direction 设置为 \'hoz\' 并且 header 存在时生效',
name: 'hozAlign',
propType: {
type: 'oneOf',
value: [
'left',
'right',
],
},
},
{
description: `设置组件选中状态的 active 边方向␊
@enumdesc 无, 上, 下, 左, 右␊
@default 当 direction 为 'hoz' 时,默认值为 'bottom',当 direction 为 'ver' 时,默认值为 'left'`,
name: 'activeDirection',
propType: {
type: 'oneOf',
value: [
null,
'top',
'bottom',
'left',
'right',
],
},
},
{
defaultValue: 'inline',
description: `子导航打开的模式(水平导航只支持弹出)␊
@eumdesc 行内, 弹出`,
name: 'mode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
{
defaultValue: 'click',
description: '子导航打开的触发方式',
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: 20,
description: '内联子导航缩进距离',
name: 'inlineIndent',
propType: 'number',
},
{
defaultValue: false,
description: '初始展开所有的子导航,只在 mode 设置为 \'inline\' 以及 openMode 设置为 \'multiple\' 下生效',
name: 'defaultOpenAll',
propType: 'bool',
},
{
defaultValue: 'multiple',
description: `内联子导航的展开模式,同时可以展开一个同级子导航还是多个同级子导航,该属性仅在 mode 为 inline 时生效␊
@eumdesc 一个, 多个`,
name: 'openMode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
],
},
},
{
description: '当前选中导航项的 key 值',
name: 'selectedKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
defaultValue: [],
description: '初始选中导航项的 key 值',
name: 'defaultSelectedKeys',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: `选中或取消选中导航项触发的回调函数␊
@param {Array} selectedKeys 选中的所有导航项的 key␊
@param {Object} item 选中或取消选中的导航项␊
@param {Object} extra 额外参数␊
@param {Boolean} extra.select 是否是选中␊
@param {Array} extra.key 导航项的 key␊
@param {Object} extra.label 导航项的文本␊
@param {Array} extra.keyPath 导航项 key 的路径`,
name: 'onSelect',
propType: 'func',
},
{
defaultValue: 'follow',
description: `弹出子导航的对齐方式(水平导航只支持 follow )␊
@eumdesc Item 顶端对齐, Nav 顶端对齐`,
name: 'popupAlign',
propType: {
type: 'oneOf',
value: [
'follow',
'outside',
],
},
},
{
description: '弹出子导航的自定义类名',
name: 'popupClassName',
propType: 'string',
},
{
description: '是否只显示图标',
name: 'iconOnly',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示右侧的箭头(仅在 iconOnly=true 时生效)',
name: 'hasArrow',
propType: 'bool',
},
{
defaultValue: false,
description: '是否有 ToolTips (仅在 iconOnly=true 时生效)',
name: 'hasTooltip',
propType: 'bool',
},
{
description: '自定义导航头部',
name: 'header',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '自定义导航尾部',
name: 'footer',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否开启嵌入式模式,一般用于Layout的布局中,开启后没有默认背景、外层border、box-shadow,可以配合`<Nav style={{lineHeight: \'100px\'}}>` 自定义高度',
name: 'embeddable',
propType: 'bool',
},
{
defaultValue: undefined,
name: 'popupProps',
propType: 'object',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Item',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Nav',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
description: '自定义图标,可以使用 Icon 的 type,也可以使用组件 `<Icon type="icon type" />`',
name: 'icon',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'node',
},
],
},
},
{
description: '导航内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'parentMode',
propType: {
type: 'oneOf',
value: [
'inline',
'popup',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Group',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Nav',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '导航项和子导航',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'SubNav',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Nav',
main: 'src/index.js',
package: '@alifd/next',
subName: 'SubNav',
version: '1.19.18',
},
props: [
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义图标,可以使用 Icon 的 type,也可以使用组件 `<Icon type="your type" />`',
name: 'icon',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'node',
},
],
},
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否可选',
name: 'selectable',
propType: 'bool',
},
{
description: '导航项和子导航',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'PopupItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Nav',
main: 'src/index.js',
package: '@alifd/next',
subName: 'PopupItem',
version: '1.19.18',
},
props: [
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义图标,可以使用 Icon 的 type, 也可以使用组件 `<Icon type="icon type" />`',
name: 'icon',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'node',
},
],
},
},
{
description: '标签内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '弹出内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'NumberPicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'NumberPicker',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'normal',
description: `设置类型␊
@enumdesc 普通, 内联`,
name: 'type',
propType: {
type: 'oneOf',
value: [
'normal',
'inline',
],
},
},
{
defaultValue: 'medium',
description: '大小',
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'medium',
],
},
},
{
description: '当前值',
name: 'value',
propType: 'number',
},
{
description: '默认值',
name: 'defaultValue',
propType: 'number',
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: 1,
description: '步长',
name: 'step',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: 0,
description: '保留小数点后位数',
name: 'precision',
propType: 'number',
},
{
defaultValue: true,
description: '用户是否可以输入',
name: 'editable',
propType: 'bool',
},
{
description: '自动焦点',
name: 'autoFocus',
propType: 'bool',
},
{
description: `数值被改变的事件␊
@param {Number} value 数据␊
@param {Event} e DOM事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: '键盘按下',
name: 'onKeyDown',
propType: 'func',
},
{
description: '焦点获得',
name: 'onFocus',
propType: 'func',
},
{
description: '焦点失去',
name: 'onBlur',
propType: 'func',
},
{
description: `数值订正后的回调␊
@param {Object} obj {currentValue,oldValue:String}`,
name: 'onCorrect',
propType: 'func',
},
{
name: 'onDisabled',
propType: 'func',
},
{
defaultValue: Infinity,
description: '最大值',
name: 'max',
propType: 'number',
},
{
defaultValue: -Infinity,
description: '最小值',
name: 'min',
propType: 'number',
},
{
description: '自定义class',
name: 'className',
propType: 'string',
},
{
defaultValue: undefined,
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
name: 'state',
propType: {
type: 'oneOf',
value: [
'error',
],
},
},
{
description: `格式化当前值␊
@param {Number} value␊
@return {String|Number}`,
name: 'format',
propType: 'func',
},
{
description: '增加按钮的props',
name: 'upBtnProps',
propType: 'object',
},
{
description: '减少按钮的props',
name: 'downBtnProps',
propType: 'object',
},
{
description: '内联 label',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: 'inner after',
name: 'innerAfter',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
{
description: '预设屏幕宽度',
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Overlay',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Overlay',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
description: '弹层内容',
name: 'children',
propType: 'any',
},
{
defaultValue: false,
description: '是否显示弹层',
name: 'visible',
propType: 'bool',
},
{
description: `弹层请求关闭时触发事件的回调函数␊
@param {String} type 弹层关闭的来源␊
@param {Object} e DOM 事件`,
name: 'onRequestClose',
propType: 'func',
},
{
description: '弹层定位的参照元素',
name: 'target',
propType: 'any',
},
{
defaultValue: 'tl bl',
description: '弹层相对于参照元素的定位, 详见开发指南的[定位部分](#定位)',
name: 'align',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: [
0,
0,
],
description: `弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量␊
e.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px`,
name: 'offset',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '渲染组件的容器,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点',
name: 'container',
propType: 'any',
},
{
defaultValue: false,
description: '是否显示遮罩',
name: 'hasMask',
propType: 'bool',
},
{
defaultValue: true,
description: '是否支持 esc 按键关闭弹层',
name: 'canCloseByEsc',
propType: 'bool',
},
{
defaultValue: true,
description: '点击弹层外的区域是否关闭弹层,不显示遮罩时生效',
name: 'canCloseByOutSideClick',
propType: 'bool',
},
{
defaultValue: true,
description: '点击遮罩区域是否关闭弹层,显示遮罩时生效',
name: 'canCloseByMask',
propType: 'bool',
},
{
description: '弹层打开前触发事件的回调函数',
name: 'beforeOpen',
propType: 'func',
},
{
description: '弹层打开时触发事件的回调函数',
name: 'onOpen',
propType: 'func',
},
{
description: '弹层打开后触发事件的回调函数, 如果有动画,则在动画结束后触发',
name: 'afterOpen',
propType: 'func',
},
{
description: '弹层关闭前触发事件的回调函数',
name: 'beforeClose',
propType: 'func',
},
{
description: '弹层关闭时触发事件的回调函数',
name: 'onClose',
propType: 'func',
},
{
description: '弹层关闭后触发事件的回调函数, 如果有动画,则在动画结束后触发',
name: 'afterClose',
propType: 'func',
},
{
description: '弹层定位完成前触发的事件',
name: 'beforePosition',
propType: 'func',
},
{
description: `弹层定位完成时触发的事件␊
@param {Object} config 定位的参数␊
@param {Array} config.align 对齐方式,如 ['cc', 'cc'](如果开启 needAdjust,可能和预先设置的 align 不同)␊
@param {Number} config.top 距离视口顶部距离␊
@param {Number} config.left 距离视口左侧距离␊
@param {Object} node 定位参照的容器节点`,
name: 'onPosition',
propType: 'func',
},
{
defaultValue: false,
description: '是否在每次弹层重新渲染后强制更新定位信息,一般用于弹层内容区域大小发生变化时,仍需保持原来的定位方式',
name: 'shouldUpdatePosition',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层打开时是否让其中的元素自动获取焦点',
name: 'autoFocus',
propType: 'bool',
},
{
defaultValue: true,
description: '当弹层由于页面滚动等情况不在可视区域时,是否自动调整定位以出现在可视区域',
name: 'needAdjust',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用页面滚动',
name: 'disableScroll',
propType: 'bool',
},
{
defaultValue: false,
description: '隐藏时是否保留子节点',
name: 'cache',
propType: 'bool',
},
{
description: '安全节点,当点击 document 的时候,如果包含该节点则不会关闭弹层,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点,或者以上值组成的数组',
name: 'safeNode',
propType: 'any',
},
{
description: '弹层的根节点的样式类',
name: 'wrapperClassName',
propType: 'string',
},
{
description: '弹层的根节点的内联样式',
name: 'wrapperStyle',
propType: 'object',
},
{
description: `配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名␊
@default { in: 'expandInDown', out: 'expandOutUp' }`,
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'object',
'bool',
],
},
},
{
name: 'onMaskMouseEnter',
propType: 'func',
},
{
name: 'onMaskMouseLeave',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onClick',
propType: 'func',
},
{
defaultValue: '',
name: 'maskClass',
propType: 'string',
},
{
defaultValue: false,
name: 'isChildrenInMask',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Gateway',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Overlay',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Gateway',
version: '1.19.18',
},
props: [
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: Function {},
name: 'container',
propType: 'any',
},
{
name: 'target',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Position',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Overlay',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Position',
version: '1.19.18',
},
props: [
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'target',
propType: 'any',
},
{
name: 'container',
propType: 'any',
},
{
defaultValue: 'tl bl',
name: 'align',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: [
0,
0,
],
name: 'offset',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'beforePosition',
propType: 'func',
},
{
name: 'onPosition',
propType: 'func',
},
{
defaultValue: true,
name: 'needAdjust',
propType: 'bool',
},
{
defaultValue: false,
name: 'autoFit',
propType: 'bool',
},
{
defaultValue: true,
name: 'needListenResize',
propType: 'bool',
},
{
defaultValue: false,
name: 'shouldUpdatePosition',
propType: 'bool',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Popup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Overlay',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Popup',
version: '1.19.18',
},
props: [
{
description: '弹层内容',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '触发弹层显示或隐藏的元素',
name: 'trigger',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
defaultValue: 'hover',
description: '触发弹层显示或隐藏的操作类型,可以是 \'click\',\'hover\',\'focus\',或者它们组成的数组,如 [\'hover\', \'focus\']',
name: 'triggerType',
propType: {
type: 'oneOfType',
value: [
'string',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '当 triggerType 为 click 时才生效,可自定义触发弹层显示的键盘码',
name: 'triggerClickKeycode',
propType: {
type: 'oneOfType',
value: [
'number',
{
type: 'instanceOf',
value: 'array',
},
],
},
},
{
description: '弹层当前是否显示',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层显示或隐藏时触发的回调函数␊
@param {Boolean} visible 弹层是否显示␊
@param {String} type 触发弹层显示或隐藏的来源 fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发␊
@param {Object} e DOM事件`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: false,
description: '设置此属性,弹层无法显示或隐藏',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: false,
name: 'autoFit',
propType: 'bool',
},
{
defaultValue: 200,
description: '弹层显示或隐藏的延时时间(以毫秒为单位),在 triggerType 被设置为 hover 时生效',
name: 'delay',
propType: 'number',
},
{
defaultValue: true,
description: 'trigger 是否可以关闭弹层',
name: 'canCloseByTrigger',
propType: 'bool',
},
{
description: `弹层定位的参照元素␊
@default target 属性,即触发元素`,
name: 'target',
propType: 'any',
},
{
name: 'safeNode',
propType: 'any',
},
{
defaultValue: false,
description: '是否跟随trigger滚动',
name: 'followTrigger',
propType: 'bool',
},
{
defaultValue: Function {},
name: 'container',
propType: 'any',
},
{
name: 'hasMask',
propType: 'bool',
},
{
name: 'wrapperStyle',
propType: 'object',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Pagination',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Pagination',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
name: 'device',
propType: {
type: 'oneOf',
value: [
'desktop',
'tablet',
'phone',
],
},
},
{
name: 'className',
propType: 'string',
},
{
description: '自定义国际化文案对象',
name: 'locale',
propType: 'object',
},
{
defaultValue: 'normal',
description: '分页组件类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'normal',
'simple',
'mini',
],
},
},
{
defaultValue: 'normal',
description: '前进后退按钮样式',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'normal',
'arrow-only',
'arrow-prev-only',
'no-border',
],
},
},
{
defaultValue: 'medium',
description: '分页组件大小',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '(受控)当前页码',
name: 'current',
propType: 'number',
},
{
defaultValue: 1,
description: '(非受控)初始页码',
name: 'defaultCurrent',
propType: 'number',
},
{
defaultValue: Function {},
description: `页码发生改变时的回调函数␊
@param {Number} current 改变后的页码数␊
@param {Object} e 点击事件对象`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: 100,
description: '总记录数',
name: 'total',
propType: 'number',
},
{
description: `总数的渲染函数␊
@param {Number} total 总数␊
@param {Array} range 当前数据在总数中的区间`,
name: 'totalRender',
propType: 'func',
},
{
defaultValue: 5,
description: '页码显示的数量,更多的使用...代替',
name: 'pageShowCount',
propType: 'number',
},
{
defaultValue: 10,
description: '一页中的记录数',
name: 'pageSize',
propType: 'number',
},
{
defaultValue: false,
description: '每页显示选择器类型',
name: 'pageSizeSelector',
propType: {
type: 'oneOf',
value: [
false,
'filter',
'dropdown',
],
},
},
{
defaultValue: Function {},
description: `自定义页码渲染函数,函数作用于页码button以及当前页/总页数的数字渲染␊
@param {Number} index 分页的页码,从1开始␊
@return {ReactNode} 返回渲染结果`,
name: 'pageNumberRender',
propType: 'func',
},
{
defaultValue: 'start',
description: '每页显示选择器在组件中的位置',
name: 'pageSizePosition',
propType: {
type: 'oneOf',
value: [
'start',
'end',
],
},
},
{
defaultValue: false,
description: '存在每页显示选择器时是否使用浮动布局',
name: 'useFloatLayout',
propType: 'bool',
},
{
defaultValue: Function {},
description: `每页显示记录数量改变时的回调函数␊
@param {Number} pageSize 改变后的每页显示记录数`,
name: 'onPageSizeChange',
propType: 'func',
},
{
defaultValue: false,
description: '当分页数为1时,是否隐藏分页器',
name: 'hideOnlyOnePage',
propType: 'bool',
},
{
defaultValue: true,
description: 'type 设置为 normal 时,在页码数超过5页后,会显示跳转输入框与按钮,当设置 showJump 为 false 时,不再显示该跳转区域',
name: 'showJump',
propType: 'bool',
},
{
description: '设置页码按钮的跳转链接,它的值为一个包含 {page} 的模版字符串,如:http://www.taobao.com/{page}',
name: 'link',
propType: 'string',
},
{
defaultValue: Function {},
name: 'selectPopupContiner',
propType: 'any',
},
{
description: '弹层组件属性,透传给Popup',
name: 'popupProps',
propType: 'object',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Paragraph',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Paragraph',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '额外的样式名 会附加到 root dom 上',
name: 'className',
propType: 'string',
},
{
defaultValue: 'long',
description: `什么方式展示段落␊
@enumdesc 展示所有文本, 展示三行以内(非强制)`,
name: 'type',
propType: {
type: 'oneOf',
value: [
'long',
'short',
],
},
},
{
defaultValue: 'medium',
description: `组件大小。␊
@enumdesc 中号, 小号`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'medium',
'small',
],
},
},
{
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Progress',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Progress',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'line',
description: '形态',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'circle',
'line',
],
},
},
{
defaultValue: 'medium',
description: '尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
defaultValue: 0,
description: '所占百分比',
name: 'percent',
propType: 'number',
},
{
defaultValue: 'normal',
description: '进度状态, 显示优先级: color > progressive > state',
name: 'state',
propType: {
type: 'oneOf',
value: [
'normal',
'success',
'error',
],
},
},
{
defaultValue: false,
description: '是否为色彩阶段变化模式, 显示优先级: color > progressive > state',
name: 'progressive',
propType: 'bool',
},
{
defaultValue: false,
description: '是否添加 Border(只适用于 Line Progress)',
name: 'hasBorder',
propType: 'bool',
},
{
defaultValue: Function {},
description: `文本渲染函数␊
@param {Number} percent 当前的进度信息␊
@param {Object} option 额外的参数␊
@property {Boolean} option.rtl 是否在rtl 模式下渲染␊
@return {ReactNode} 返回文本节点`,
name: 'textRender',
propType: 'func',
},
{
description: '进度条颜色, 显示优先级: color > progressive > state',
name: 'color',
propType: 'string',
},
{
description: '背景色',
name: 'backgroundColor',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Radio',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Radio',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '组件input的id',
name: 'id',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: '设置radio是否选中',
name: 'checked',
propType: 'bool',
},
{
description: '设置radio是否默认选中',
name: 'defaultChecked',
propType: 'bool',
},
{
description: '通过属性配置label',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: `状态变化时触发的事件␊
@param {Boolean} checked 是否选中␊
@param {Event} e Dom 事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: `鼠标进入enter事件␊
@param {Event} e Dom 事件对象`,
name: 'onMouseEnter',
propType: 'func',
},
{
description: `鼠标离开事件␊
@param {Event} e Dom 事件对象`,
name: 'onMouseLeave',
propType: 'func',
},
{
description: 'radio是否被禁用',
name: 'disabled',
propType: 'bool',
},
{
description: 'radio 的value',
name: 'value',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
'bool',
],
},
},
{
description: 'name',
name: 'name',
propType: 'string',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
{
defaultValue: 0,
name: 'tabIndex',
},
{
defaultValue: 'next-',
name: 'prefix',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'RadioGroup',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Radio',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Group',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: 'name',
name: 'name',
propType: 'string',
},
{
description: 'radio group的选中项的值',
name: 'value',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
'bool',
],
},
},
{
description: 'radio group的默认值',
name: 'defaultValue',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
'bool',
],
},
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'oneOfType',
value: [
'string',
'func',
],
},
},
{
defaultValue: Function {},
description: `选中值改变时的事件␊
@param {String/Number} value 选中项的值␊
@param {Event} e Dom 事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: '表示radio被禁用',
name: 'disabled',
propType: 'bool',
},
{
description: `可以设置成 button 展示形状␊
@enumdesc 按钮状`,
name: 'shape',
propType: {
type: 'oneOf',
value: [
'button',
],
},
},
{
defaultValue: 'medium',
description: `与 `shape` 属性配套使用,shape设为button时有效␊
@enumdesc 大, 中, 小`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'medium',
'small',
],
},
},
{
defaultValue: 'hoz',
description: `子项目的排列方式␊
- hoz: 水平排列 (default)␊
- ver: 垂直排列`,
name: 'itemDirection',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Range',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Range',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式类名的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
defaultValue: 'single',
description: `滑块个数␊
@enumdesc 单个, 两个`,
name: 'slider',
propType: {
type: 'oneOf',
value: [
'single',
'double',
],
},
},
{
defaultValue: 0,
description: '最小值',
name: 'min',
propType: 'number',
},
{
defaultValue: 100,
description: '最大值',
name: 'max',
propType: 'number',
},
{
defaultValue: 1,
description: '步长,取值必须大于 0,并且可被 (max - min) 整除。',
name: 'step',
propType: 'number',
},
{
defaultValue: 'above',
description: 'marks显示在上方(\'above\')or下方(\'below\')',
name: 'marksPosition',
propType: {
type: 'oneOf',
value: [
'above',
'below',
],
},
},
{
defaultValue: false,
description: '值为 `true` 时,滑块为禁用状态',
name: 'disabled',
propType: 'bool',
},
{
description: `当 Range 的值发生改变后,会触发 onChange 事件,并把改变后的值作为参数传入, 如果设置了value, 要配合此函数做受控使用␊
@param {String/number} value`,
name: 'onChange',
propType: 'func',
},
{
description: `滑块拖动的时候触发的事件,不建议在这里setState, 一般情况下不需要用, 滑动时有特殊需求时使用␊
@param {String/number} value`,
name: 'onProcess',
propType: 'func',
},
{
defaultValue: true,
description: '是否显示 tip',
name: 'hasTip',
propType: 'bool',
},
{
defaultValue: Function {},
description: `自定义 tip 显示内容␊
@param {Number|String} value 值␊
@return {ReactNode} 显示内容`,
name: 'tipRender',
propType: 'func',
},
{
name: 'id',
propType: 'string',
},
{
defaultValue: false,
description: '选中态反转',
name: 'reverse',
propType: 'bool',
},
{
defaultValue: false,
description: '是否pure render',
name: 'pure',
propType: 'bool',
},
{
defaultValue: false,
description: '是否为拖动线段类型,默认slider为double, defaultValue必传且指定区间',
name: 'fixedWidth',
propType: 'bool',
},
{
defaultValue: false,
description: 'tooltip是否默认展示',
name: 'tooltipVisible',
propType: 'bool',
},
{
defaultValue: false,
description: '是否已rtl模式展示',
name: 'rtl',
propType: 'bool',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Rating',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Rating',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 0,
description: '默认值',
name: 'defaultValue',
propType: 'number',
},
{
description: '值',
name: 'value',
propType: 'number',
},
{
defaultValue: 5,
description: '评分的总数',
name: 'count',
propType: 'number',
},
{
defaultValue: false,
description: '是否显示 grade',
name: 'showGrade',
propType: 'bool',
},
{
defaultValue: 'medium',
description: '尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
defaultValue: false,
description: '是否允许半星评分',
name: 'allowHalf',
propType: 'bool',
},
{
description: `用户点击评分时触发的回调␊
@param {String} value 评分值`,
name: 'onChange',
propType: 'func',
},
{
description: `用户hover评分时触发的回调␊
@param {String} value 评分值`,
name: 'onHoverChange',
propType: 'func',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: Function {},
description: '评分文案生成方法,传入id支持无障碍时,读屏软件可读',
name: 'readAs',
propType: 'func',
},
{
defaultValue: 'favorites-filling',
name: 'iconType',
propType: 'string',
},
{
name: 'strokeMode',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'id',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '自定义国际化文案对象',
name: 'locale',
propType: 'object',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
{
defaultValue: false,
description: '是否为只读态,效果上同 disabeld',
name: 'readOnly',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Search',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Search',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'normal',
description: '形状',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'normal',
'simple',
],
},
},
{
defaultValue: 'normal',
description: '类型 shape=normal: primary/secondary; shape=simple: normal/dark;',
name: 'type',
propType: {
type: 'oneOf',
value: [
'primary',
'secondary',
'normal',
'dark',
],
},
},
{
defaultValue: 'medium',
description: `大小␊
@enumdesc '大', '小'`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'large',
'medium',
],
},
},
{
description: '搜索框默认值',
name: 'defaultValue',
propType: 'string',
},
{
description: '搜索框数值',
name: 'value',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
description: `输入关键字时的回掉␊
@param {Object} value 输入值`,
name: 'onChange',
propType: 'func',
},
{
description: `点击搜索按钮触发的回调␊
@param {String} value 输入值␊
@param {String} filterValue 选项值`,
name: 'onSearch',
propType: 'func',
},
{
description: '选择器默认值',
name: 'defaultFilterValue',
propType: 'string',
},
{
defaultValue: [],
description: '选择器',
name: 'filter',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '选择器值',
name: 'filterValue',
propType: 'string',
},
{
description: `选择器发生变化时回调␊
@param {Object} filter value`,
name: 'onFilterChange',
propType: 'func',
},
{
description: '搜索框下拉联想列表',
name: 'dataSource',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '默认提示',
name: 'placeholder',
propType: 'string',
},
{
description: 'button 的内容',
name: 'searchText',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '自定义样式',
name: 'style',
propType: 'object',
},
{
description: '样式名称',
name: 'className',
propType: 'string',
},
{
description: '选择器的props',
name: 'filterProps',
propType: 'object',
},
{
defaultValue: undefined,
description: '按钮的额外属性',
name: 'buttonProps',
propType: 'object',
},
{
description: '自定义渲染的的下拉框',
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '自定义渲染的的下拉框',
name: 'visible',
propType: 'bool',
},
{
defaultValue: false,
description: '是否显示清除按钮',
name: 'hasClear',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示搜索按钮',
name: 'hasIcon',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Select',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Select',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'single',
description: '选择器模式',
name: 'mode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
'tag',
],
},
},
{
description: '当前值,用于受控模式',
name: 'value',
propType: 'any',
},
{
description: '初始的默认值',
name: 'defaultValue',
propType: 'any',
},
{
description: `Select发生改变时触发的回调␊
@param {*} value 选中的值␊
@param {String} actionType 触发的方式, 'itemClick', 'enter', 'tag'␊
@param {*} item 选中的值的对象数据 (useDetailValue=false有效)`,
name: 'onChange',
propType: 'func',
},
{
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有下拉箭头',
name: 'hasArrow',
propType: 'bool',
},
{
defaultValue: false,
description: '展开后是否能搜索(tag 模式下固定为true)',
name: 'showSearch',
propType: 'bool',
},
{
description: `当搜索框值变化时回调␊
@param {String} value 数据`,
name: 'onSearch',
propType: 'func',
},
{
description: `当搜索框值被清空时候的回调␊
@param {String} actionType 触发的方式, 'select'(选择清空), 'popupClose'(弹窗关闭清空)`,
name: 'onSearchClear',
propType: 'func',
},
{
description: '多选模式下是否有全选功能',
name: 'hasSelectAll',
propType: {
type: 'oneOfType',
value: [
'bool',
'string',
],
},
},
{
description: '填充到选择框里的值的 key',
name: 'fillProps',
propType: 'string',
},
{
description: 'onChange 返回的 value 使用 dataSource 的对象',
name: 'useDetailValue',
propType: 'bool',
},
{
defaultValue: true,
description: 'dataSource 变化的时是否保留已选的内容',
name: 'cacheValue',
propType: 'bool',
},
{
defaultValue: Function {},
description: `渲染 Select 展现内容的方法␊
@param {Object} item 渲染节点的item␊
@return {ReactNode} 展现内容␊
@default item => item.label \\|\\| item.value`,
name: 'valueRender',
propType: 'func',
},
{
description: `渲染 MenuItem 内容的方法␊
@param {Object} item 渲染节点的item␊
@param {String} searchValue 搜索关键字(如果开启搜索)␊
@return {ReactNode} item node`,
name: 'itemRender',
propType: 'func',
},
{
description: '弹层内容为空的文案',
name: 'notFoundContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'style',
propType: 'object',
},
{
description: `受控搜索值,一般不需要设置␊
@type {[type]}`,
name: 'searchValue',
propType: 'string',
},
{
defaultValue: false,
description: '是否一行显示,仅在 mode 为 multiple 的时候生效',
name: 'tagInline',
propType: 'bool',
},
{
description: '最多显示多少个 tag',
name: 'maxTagCount',
propType: 'number',
},
{
description: `隐藏多余 tag 时显示的内容,在 maxTagCount 生效时起作用␊
@param {number} selectedValues 当前已选中的元素␊
@param {number} totalValues 总待选元素`,
name: 'maxTagPlaceholder',
propType: 'func',
},
{
description: '选择后是否立即隐藏菜单 (mode=multiple/tag 模式生效)',
name: 'hiddenSelected',
propType: 'bool',
},
{
description: `tag 删除回调␊
@param {object} item 渲染节点的item`,
name: 'onRemove',
propType: 'func',
},
{
description: '焦点事件',
name: 'onFocus',
propType: 'func',
},
{
description: '失去焦点事件',
name: 'onBlur',
propType: 'func',
},
{
name: 'onMouseEnter',
propType: 'func',
},
{
name: 'onMouseLeave',
propType: 'func',
},
{
name: 'onKeyDown',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Select',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Select',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Combobox',
version: '1.19.18',
},
props: [
{
defaultValue: 'single',
description: '选择器模式',
name: 'mode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
'tag',
],
},
},
{
description: '当前值,用于受控模式',
name: 'value',
propType: 'any',
},
{
description: '初始的默认值',
name: 'defaultValue',
propType: 'any',
},
{
description: `Select发生改变时触发的回调␊
@param {*} value 选中的值␊
@param {String} actionType 触发的方式, 'itemClick', 'enter', 'tag'␊
@param {*} item 选中的值的对象数据 (useDetailValue=false有效)`,
name: 'onChange',
propType: 'func',
},
{
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有下拉箭头',
name: 'hasArrow',
propType: 'bool',
},
{
defaultValue: false,
description: '展开后是否能搜索(tag 模式下固定为true)',
name: 'showSearch',
propType: 'bool',
},
{
description: `当搜索框值变化时回调␊
@param {String} value 数据`,
name: 'onSearch',
propType: 'func',
},
{
description: `当搜索框值被清空时候的回调␊
@param {String} actionType 触发的方式, 'select'(选择清空), 'popupClose'(弹窗关闭清空)`,
name: 'onSearchClear',
propType: 'func',
},
{
description: '多选模式下是否有全选功能',
name: 'hasSelectAll',
propType: {
type: 'oneOfType',
value: [
'bool',
'string',
],
},
},
{
description: '填充到选择框里的值的 key',
name: 'fillProps',
propType: 'string',
},
{
description: 'onChange 返回的 value 使用 dataSource 的对象',
name: 'useDetailValue',
propType: 'bool',
},
{
defaultValue: true,
description: 'dataSource 变化的时是否保留已选的内容',
name: 'cacheValue',
propType: 'bool',
},
{
defaultValue: Function {},
description: `渲染 Select 展现内容的方法␊
@param {Object} item 渲染节点的item␊
@return {ReactNode} 展现内容␊
@default item => item.label \\|\\| item.value`,
name: 'valueRender',
propType: 'func',
},
{
description: `渲染 MenuItem 内容的方法␊
@param {Object} item 渲染节点的item␊
@param {String} searchValue 搜索关键字(如果开启搜索)␊
@return {ReactNode} item node`,
name: 'itemRender',
propType: 'func',
},
{
description: '弹层内容为空的文案',
name: 'notFoundContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'style',
propType: 'object',
},
{
description: `受控搜索值,一般不需要设置␊
@type {[type]}`,
name: 'searchValue',
propType: 'string',
},
{
defaultValue: false,
description: '是否一行显示,仅在 mode 为 multiple 的时候生效',
name: 'tagInline',
propType: 'bool',
},
{
description: '最多显示多少个 tag',
name: 'maxTagCount',
propType: 'number',
},
{
description: `隐藏多余 tag 时显示的内容,在 maxTagCount 生效时起作用␊
@param {number} selectedValues 当前已选中的元素␊
@param {number} totalValues 总待选元素`,
name: 'maxTagPlaceholder',
propType: 'func',
},
{
description: '选择后是否立即隐藏菜单 (mode=multiple/tag 模式生效)',
name: 'hiddenSelected',
propType: 'bool',
},
{
description: `tag 删除回调␊
@param {object} item 渲染节点的item`,
name: 'onRemove',
propType: 'func',
},
{
description: '焦点事件',
name: 'onFocus',
propType: 'func',
},
{
description: '失去焦点事件',
name: 'onBlur',
propType: 'func',
},
{
name: 'onMouseEnter',
propType: 'func',
},
{
name: 'onMouseLeave',
propType: 'func',
},
{
name: 'onKeyDown',
propType: 'func',
},
{
name: 'locale',
propType: 'object',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Slider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Slider',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '自定义传入的样式',
name: 'className',
propType: 'any',
},
{
defaultValue: false,
description: '是否使用自适应高度',
name: 'adaptiveHeight',
propType: 'bool',
},
{
defaultValue: 'slide',
description: '动效类型,默认是\'slide\'',
name: 'animation',
propType: {
type: 'oneOfType',
value: [
'string',
'bool',
],
},
},
{
defaultValue: true,
description: '是否显示箭头',
name: 'arrows',
propType: 'bool',
},
{
defaultValue: 'medium',
description: '导航箭头大小 可选值: \'medium\', \'large\'',
name: 'arrowSize',
propType: {
type: 'oneOf',
value: [
'medium',
'large',
],
},
},
{
defaultValue: 'inner',
description: '导航箭头位置 可选值: \'inner\', \'outer\'',
name: 'arrowPosition',
propType: {
type: 'oneOf',
value: [
'inner',
'outer',
],
},
},
{
defaultValue: 'hoz',
description: '导航箭头的方向 可选值: \'hoz\', \'ver\'',
name: 'arrowDirection',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: false,
description: '是否自动播放',
name: 'autoplay',
propType: 'bool',
},
{
defaultValue: 3000,
description: '自动播放的速度',
name: 'autoplaySpeed',
propType: 'number',
},
{
defaultValue: null,
description: '向后箭头',
name: 'nextArrow',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
defaultValue: null,
description: '向前箭头',
name: 'prevArrow',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
defaultValue: false,
description: '是否启用居中模式',
name: 'centerMode',
propType: 'bool',
},
{
defaultValue: true,
description: '是否显示导航锚点',
name: 'dots',
propType: 'bool',
},
{
defaultValue: 'hoz',
description: '导航锚点位置',
name: 'dotsDirection',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
name: 'dotsClass',
propType: 'string',
},
{
description: '自定义导航锚点',
name: 'dotRender',
propType: 'func',
},
{
defaultValue: true,
description: '是否可拖拽',
name: 'draggable',
propType: 'bool',
},
{
defaultValue: true,
description: '是否使用无穷循环模式',
name: 'infinite',
propType: 'bool',
},
{
defaultValue: 0,
description: '初始被激活的轮播图',
name: 'defaultActiveIndex',
propType: 'number',
},
{
defaultValue: false,
description: '是否启用懒加载',
name: 'lazyLoad',
propType: 'bool',
},
{
defaultValue: 'div',
name: 'slide',
propType: 'string',
},
{
defaultValue: 'hoz',
description: '轮播方向',
name: 'slideDirection',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 1,
description: '同时展示的图片数量',
name: 'slidesToShow',
propType: 'number',
},
{
defaultValue: 1,
description: '同时滑动的图片数量',
name: 'slidesToScroll',
propType: 'number',
},
{
defaultValue: 600,
description: '轮播速度',
name: 'speed',
propType: 'number',
},
{
description: '跳转到指定的轮播图(受控)',
name: 'activeIndex',
propType: 'number',
},
{
defaultValue: 'click',
description: '锚点导航触发方式',
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
defaultValue: Function {},
description: `轮播切换的回调函数␊
@param {Number} index 幻灯片的索引`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onBeforeChange',
propType: 'func',
},
{
name: 'children',
propType: 'any',
},
{
defaultValue: null,
description: '自定义传入的class',
name: 'style',
propType: 'object',
},
{
defaultValue: '50px',
description: 'Side padding when in center mode (px or %); 展示部分为center,pading会产生前后预览',
name: 'centerPadding',
propType: 'string',
},
{
defaultValue: 'ease',
description: 'CSS3 Animation Easing,默认‘ease’',
name: 'cssEase',
propType: 'string',
},
{
defaultValue: 0.35,
name: 'edgeFriction',
propType: 'number',
},
{
defaultValue: false,
description: '多图轮播时,点击选中后自动居中',
name: 'focusOnSelect',
propType: 'bool',
},
{
defaultValue: false,
name: 'pauseOnHover',
propType: 'bool',
},
{
defaultValue: true,
name: 'swipe',
propType: 'bool',
},
{
defaultValue: false,
name: 'swipeToSlide',
propType: 'bool',
},
{
defaultValue: true,
name: 'touchMove',
propType: 'bool',
},
{
defaultValue: 5,
name: 'touchThreshold',
propType: 'number',
},
{
defaultValue: true,
name: 'useCSS',
propType: 'bool',
},
{
defaultValue: false,
name: 'variableWidth',
propType: 'bool',
},
{
defaultValue: true,
name: 'waitForAnimate',
propType: 'bool',
},
{
defaultValue: null,
name: 'edgeEvent',
propType: 'any',
},
{
defaultValue: null,
name: 'swipeEvent',
propType: 'any',
},
{
defaultValue: false,
name: 'vertical',
},
{
defaultValue: false,
name: 'verticalSwiping',
},
{
defaultValue: null,
name: 'dotsRender',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'SplitButton',
docUrl: '',
npm: {
destructuring: true,
exportName: 'SplitButton',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
defaultValue: 'normal',
description: '按钮的类型',
name: 'type',
propType: {
type: 'oneOf',
value: [
'normal',
'primary',
'secondary',
],
},
},
{
defaultValue: 'medium',
description: '按钮组的尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '主按钮的文案',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '设置标签类型',
name: 'component',
propType: {
type: 'oneOf',
value: [
'button',
'a',
],
},
},
{
description: '是否为幽灵按钮',
name: 'ghost',
propType: {
type: 'oneOf',
value: [
'light',
'dark',
false,
true,
],
},
},
{
defaultValue: [],
description: '默认激活的菜单项(用法同 Menu 非受控)',
name: 'defaultSelectedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '激活的菜单项(用法同 Menu 受控)',
name: 'selectedKeys',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '菜单的选择模式',
name: 'selectMode',
propType: {
type: 'oneOf',
value: [
'single',
'multiple',
],
},
},
{
description: '选择菜单项时的回调,参考 Menu',
name: 'onSelect',
propType: 'func',
},
{
description: '点击菜单项时的回调,参考 Menu',
name: 'onItemClick',
propType: 'func',
},
{
description: '触发按钮的属性(支持 Button 的所有属性透传)',
name: 'triggerProps',
propType: 'object',
},
{
defaultValue: true,
description: '弹层菜单的宽度是否与按钮组一致',
name: 'autoWidth',
propType: 'bool',
},
{
description: '弹层是否显示',
name: 'visible',
propType: 'bool',
},
{
description: '弹层默认是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层显示状态变化时的回调函数␊
@param {Boolean} visible 弹层显示状态␊
@param {String} type 触发弹层显示或隐藏的来源 menuSelect 表示由menu触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
defaultValue: 'click',
description: '弹层的触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
description: '弹层对齐方式, 详情见Overlay align',
name: 'popupAlign',
propType: 'string',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '透传给弹层的属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
defaultValue: undefined,
description: '透传给 Menu 的属性',
name: 'menuProps',
propType: 'object',
},
{
defaultValue: undefined,
description: '透传给 左侧按钮 的属性',
name: 'leftButtonProps',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Step',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Step',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
defaultValue: 0,
description: '当前步骤',
name: 'current',
propType: 'number',
},
{
defaultValue: 'hoz',
description: '展示方向',
name: 'direction',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 'ver',
description: '横向布局时( direction 为 hoz )的内容排列',
name: 'labelPlacement',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 'circle',
description: '类型',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'circle',
'arrow',
'dot',
],
},
},
{
description: '是否只读模式',
name: 'readOnly',
propType: 'bool',
},
{
defaultValue: true,
description: '是否开启动效',
name: 'animation',
propType: 'bool',
},
{
description: '自定义样式名',
name: 'className',
propType: 'string',
},
{
defaultValue: null,
description: `StepItem 的自定义渲染␊
@param {Number} index 节点索引␊
@param {String} status 节点状态␊
@returns {Node} 节点的渲染结果`,
name: 'itemRender',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'StepItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Step',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '步骤的状态,如不传,会根据外层的 Step 的 current 属性生成,可选值为 `wait`, `process`, `finish`',
name: 'status',
propType: {
type: 'oneOf',
value: [
'wait',
'process',
'finish',
],
},
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'direction',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
name: 'labelPlacement',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 'circle',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'circle',
'arrow',
'dot',
],
},
},
{
description: '图标',
name: 'icon',
propType: 'string',
},
{
description: '内容填充, shape为 arrow 时无效',
name: 'content',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: `StepItem 的自定义渲染, 会覆盖父节点设置的itemRender␊
@param {Number} index 节点索引␊
@param {String} status 节点状态␊
@returns {Node} 节点的渲染结果`,
name: 'itemRender',
propType: 'func',
},
{
description: '百分比',
name: 'percent',
propType: 'number',
},
{
defaultValue: 0,
name: 'index',
propType: 'number',
},
{
defaultValue: 1,
name: 'total',
propType: 'number',
},
{
name: 'animation',
propType: 'bool',
},
{
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
name: 'parentWidth',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
name: 'parentHeight',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
],
},
},
{
defaultValue: Function {},
description: `点击步骤时的回调␊
@param {Number} index 节点索引`,
name: 'onClick',
propType: 'func',
},
{
description: '自定义样式',
name: 'className',
propType: 'string',
},
{
name: 'readOnly',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Switch',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Switch',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'pure',
propType: 'bool',
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
description: '自定义内敛样式',
name: 'style',
propType: 'object',
},
{
description: '打开时的内容',
name: 'checkedChildren',
propType: 'any',
},
{
description: '关闭时的内容',
name: 'unCheckedChildren',
propType: 'any',
},
{
defaultValue: Function {},
description: `开关状态改变是触发此事件␊
@param {Boolean} checked 是否为打开状态␊
@param {Event} e DOM事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: '开关当前的值(针对受控组件)',
name: 'checked',
propType: 'bool',
},
{
defaultValue: false,
description: '开关默认值 (针对非受控组件)',
name: 'defaultChecked',
propType: 'bool',
},
{
defaultValue: false,
description: '表示开关被禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: 'medium',
description: `switch的尺寸␊
@enumdesc 正常大小, 缩小版大小`,
name: 'size',
propType: {
type: 'oneOf',
value: [
'medium',
'small',
],
},
},
{
description: `鼠标点击事件␊
@param {Event} e DOM事件对象`,
name: 'onClick',
propType: 'func',
},
{
description: `键盘按键事件␊
@param {Event} e DOM事件对象`,
name: 'onKeyDown',
propType: 'func',
},
{
defaultValue: false,
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
{
description: '国际化配置',
name: 'locale',
propType: 'object',
},
{
defaultValue: false,
name: 'readOnly',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Tab',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tab',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'device',
propType: {
type: 'oneOf',
value: [
'tablet',
'desktop',
'phone',
],
},
},
{
description: '被激活的选项卡的 key, 赋值则tab为受控组件, 用户无法切换',
name: 'activeKey',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
description: '初始化时被激活的选项卡的 key',
name: 'defaultActiveKey',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: 'pure',
description: '外观形态',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'pure',
'wrapped',
'text',
'capsule',
],
},
},
{
defaultValue: true,
description: '是否开启动效',
name: 'animation',
propType: 'bool',
},
{
defaultValue: 'slide',
description: '选项卡过多时的滑动模式',
name: 'excessMode',
propType: {
type: 'oneOf',
value: [
'slide',
'dropdown',
],
},
},
{
defaultValue: 'top',
description: '导航选项卡的位置,只适用于包裹型(wrapped)选项卡',
name: 'tabPosition',
propType: {
type: 'oneOf',
value: [
'top',
'bottom',
'left',
'right',
],
},
},
{
defaultValue: 'medium',
description: '尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
],
},
},
{
defaultValue: 'click',
description: '激活选项卡的触发方式',
name: 'triggerType',
propType: {
type: 'oneOf',
value: [
'hover',
'click',
],
},
},
{
defaultValue: true,
description: '是否延迟加载 TabPane 的内容, 默认开启, 即不提前渲染',
name: 'lazyLoad',
propType: 'bool',
},
{
defaultValue: false,
description: '是否自动卸载未处于激活状态的选项卡',
name: 'unmountInactiveTabs',
propType: 'bool',
},
{
description: '导航条的自定义样式',
name: 'navStyle',
propType: 'object',
},
{
description: '导航条的自定义样式类',
name: 'navClassName',
propType: 'string',
},
{
description: '内容区容器的自定义样式',
name: 'contentStyle',
propType: 'object',
},
{
description: '内容区容器的自定义样式类',
name: 'contentClassName',
propType: 'string',
},
{
description: '导航栏附加内容',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: Function {},
description: '点击单个选项卡时触发的回调',
name: 'onClick',
propType: 'func',
},
{
defaultValue: Function {},
description: `选项卡发生切换时的事件回调␊
@param {String|Number} key 改变后的 key`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: Function {},
description: `选项卡被关闭时的事件回调␊
@param {String|Number} key 关闭的选项卡的 key`,
name: 'onClose',
propType: 'func',
},
{
description: `自定义选项卡模板渲染函数␊
@param {String} key 当前 Tab.Item 的 key 值␊
@param {Object} props 传给 Tab.Item 的所有属性键值对␊
@return {ReactNode} 返回自定义组件`,
name: 'tabRender',
propType: 'func',
},
{
description: '弹层属性透传, 只有当 excessMode 为 dropdown 时生效',
name: 'popupProps',
propType: 'object',
},
{
name: 'children',
propType: 'any',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TabItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tab',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '选项卡标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '单个选项卡是否可关闭',
name: 'closeable',
propType: 'bool',
},
{
description: '选项卡是否被禁用',
name: 'disabled',
propType: 'bool',
},
{
name: 'active',
propType: 'bool',
},
{
name: 'lazyLoad',
propType: 'bool',
},
{
name: 'unmountInactiveTabs',
propType: 'bool',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TabItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tab',
main: 'src/index.js',
package: '@alifd/next',
subName: 'TabPane',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '选项卡标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '单个选项卡是否可关闭',
name: 'closeable',
propType: 'bool',
},
{
description: '选项卡是否被禁用',
name: 'disabled',
propType: 'bool',
},
{
name: 'active',
propType: 'bool',
},
{
name: 'lazyLoad',
propType: 'bool',
},
{
name: 'unmountInactiveTabs',
propType: 'bool',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TimePicker',
docUrl: '',
npm: {
destructuring: true,
exportName: 'TimePicker',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '按钮的文案',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '输入框状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'error',
'success',
],
},
},
{
description: '输入框提示',
name: 'placeholder',
propType: 'string',
},
{
description: '时间值(moment 对象或时间字符串,受控状态使用)',
name: 'value',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
description: '时间初值(moment 对象或时间字符串,非受控状态使用)',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'custom',
},
},
{
defaultValue: 'medium',
description: '时间选择框的尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
defaultValue: true,
description: '是否允许清空时间',
name: 'hasClear',
propType: 'bool',
},
{
defaultValue: 'HH:mm:ss',
description: `时间的格式␊
https://momentjs.com/docs/#/parsing/string-format/`,
name: 'format',
propType: 'string',
},
{
description: '小时选项步长',
name: 'hourStep',
propType: 'number',
},
{
description: '分钟选项步长',
name: 'minuteStep',
propType: 'number',
},
{
description: '秒钟选项步长',
name: 'secondStep',
propType: 'number',
},
{
description: `禁用小时函数␊
@param {Number} index 时 0 - 23␊
@return {Boolean} 是否禁用`,
name: 'disabledHours',
propType: 'func',
},
{
description: `禁用分钟函数␊
@param {Number} index 分 0 - 59␊
@return {Boolean} 是否禁用`,
name: 'disabledMinutes',
propType: 'func',
},
{
description: `禁用秒钟函数␊
@param {Number} index 秒 0 - 59␊
@return {Boolean} 是否禁用`,
name: 'disabledSeconds',
propType: 'func',
},
{
description: `渲染的可选择时间列表␊
[{␊
label: '01',␊
value: 1␊
}]␊
@param {Array} list 默认渲染的列表␊
@param {String} mode 渲染的菜单 hour, minute, second␊
@param {moment} value 当前时间,可能为 null␊
@return {Array} 返回需要渲染的数据`,
name: 'renderTimeMenuItems',
propType: 'func',
},
{
description: '弹层是否显示(受控)',
name: 'visible',
propType: 'bool',
},
{
description: '弹层默认是否显示(非受控)',
name: 'defaultVisible',
propType: 'bool',
},
{
description: `弹层容器␊
@param {Object} target 目标节点␊
@return {ReactNode} 容器节点`,
name: 'popupContainer',
propType: 'any',
},
{
defaultValue: 'tl tl',
description: '弹层对齐方式, 详情见Overlay 文档',
name: 'popupAlign',
propType: 'string',
},
{
defaultValue: 'click',
description: '弹层触发方式',
name: 'popupTriggerType',
propType: {
type: 'oneOf',
value: [
'click',
'hover',
],
},
},
{
description: `弹层展示状态变化时的回调␊
@param {Boolean} visible 弹层是否隐藏和显示␊
@param {String} type 触发弹层显示和隐藏的来源 fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发`,
name: 'onVisibleChange',
propType: 'func',
},
{
description: '弹层自定义样式',
name: 'popupStyle',
propType: 'object',
},
{
description: '弹层自定义样式类',
name: 'popupClassName',
propType: 'string',
},
{
description: '弹层属性',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {MomentObject} value 时间`,
name: 'renderPreview',
propType: 'func',
},
{
description: `时间值改变时的回调␊
@param {Object|String} value 时间对象或时间字符串`,
name: 'onChange',
propType: 'func',
},
{
name: 'className',
propType: 'string',
},
{
name: 'name',
propType: 'string',
},
{
name: 'inputProps',
propType: 'object',
},
{
name: 'popupComponent',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'popupContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'locale',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Timeline',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Timeline',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式的品牌前缀',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
defaultValue: [],
description: '自定义折叠选项 示例`[{foldArea: [startIndex, endIndex], foldShow: boolean}]`',
name: 'fold',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '自定义类名',
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
{
name: 'locale',
propType: 'object',
},
{
defaultValue: true,
name: 'animation',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TimelineItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Timeline',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'index',
propType: 'number',
},
{
name: 'total',
propType: 'number',
},
{
name: 'folderIndex',
propType: 'number',
},
{
name: 'foldShow',
propType: 'bool',
},
{
defaultValue: 'done',
description: '节点状态',
name: 'state',
propType: {
type: 'oneOf',
value: [
'done',
'process',
'error',
'success',
],
},
},
{
description: '图标',
name: 'icon',
propType: 'string',
},
{
description: '自定义时间轴节点',
name: 'dot',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '格式化后的时间',
name: 'time',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '左侧时间',
name: 'timeLeft',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '右侧内容',
name: 'content',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: Function {},
name: 'toggleFold',
propType: 'func',
},
{
name: 'className',
propType: 'string',
},
{
name: 'locale',
propType: 'object',
},
{
defaultValue: true,
description: '动画',
name: 'animation',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Transfer',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Transfer',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 'normal',
description: '移动选项模式',
name: 'mode',
propType: {
type: 'oneOf',
value: [
'normal',
'simple',
],
},
},
{
description: `值发生改变的时候触发的回调函数␊
@param {Array} value 右面板值␊
@param {Array} data 右面板数据␊
@param {Object} extra 额外参数␊
@param {Array} extra.leftValue 左面板值␊
@param {Array} extra.leftData 左面板数据␊
@param {Array} extra.movedValue 发生移动的值␊
@param {Object} extra.movedData 发生移动的数据␊
@param {String} extra.direction 移动的方向,值为'left'或'right'`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用左侧面板',
name: 'leftDisabled',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁用右侧面板',
name: 'rightDisabled',
propType: 'bool',
},
{
defaultValue: Function {},
description: `列表项渲染函数␊
@param {Object} data 数据␊
@return {ReactNode} 列表项内容`,
name: 'itemRender',
propType: 'func',
},
{
defaultValue: false,
description: '是否显示搜索框',
name: 'showSearch',
propType: 'bool',
},
{
defaultValue: Function {},
description: `自定义搜索函数␊
@param {String} searchedValue 搜索的内容␊
@param {Object} data 数据␊
@return {Boolean} 是否匹配到␊
@default 根据 label 属性匹配`,
name: 'filter',
propType: 'func',
},
{
defaultValue: Function {},
description: `搜索框输入时触发的回调函数␊
@param {String} searchedValue 搜索的内容␊
@param {String} position 搜索面板的位置`,
name: 'onSearch',
propType: 'func',
},
{
description: '搜索框占位符',
name: 'searchPlaceholder',
propType: 'string',
},
{
defaultValue: 'Not Found',
description: '列表为空显示内容',
name: 'notFoundContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '左右面板列表自定义样式类名',
name: 'listClassName',
propType: 'string',
},
{
description: '左右面板列表自定义样式对象',
name: 'listStyle',
propType: 'object',
},
{
defaultValue: false,
description: '是否允许拖拽排序',
name: 'sortable',
propType: 'bool',
},
{
defaultValue: Function {},
description: `拖拽排序时触发的回调函数␊
@param {Array} value 排序后的值␊
@param {String} position 拖拽的面板位置,值为:left 或 right`,
name: 'onSort',
propType: 'func',
},
{
description: '自定义国际化文案对象',
name: 'locale',
propType: 'object',
},
{
description: '请设置 id 以保证transfer的可访问性',
name: 'id',
propType: 'string',
},
{
description: '接收 children 自定义渲染列表',
name: 'children',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Tree',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tree',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '树节点',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '数据源,该属性优先级高于 children',
name: 'dataSource',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: false,
description: '是否显示树的线',
name: 'showLine',
propType: 'bool',
},
{
defaultValue: true,
description: '是否支持选中节点',
name: 'selectable',
propType: 'bool',
},
{
description: `选中或取消选中节点时触发的回调函数␊
@param {Array} selectedKeys 选中节点key的数组␊
@param {Object} extra 额外参数␊
@param {Array} extra.selectedNodes 选中节点的数组␊
@param {Object} extra.node 当前操作的节点␊
@param {Boolean} extra.selected 当前操作是否是选中`,
name: 'onSelect',
propType: 'func',
},
{
defaultValue: false,
description: '是否支持多选',
name: 'multiple',
propType: 'bool',
},
{
defaultValue: false,
description: '是否支持勾选节点的复选框',
name: 'checkable',
propType: 'bool',
},
{
defaultValue: false,
description: '勾选节点复选框是否完全受控(父子节点选中状态不再关联)',
name: 'checkStrictly',
propType: 'bool',
},
{
defaultValue: 'all',
description: `定义选中时回填的方式␊
@enumdesc 返回所有选中的节点, 父子节点都选中时只返回父节点, 父子节点都选中时只返回子节点`,
name: 'checkedStrategy',
propType: {
type: 'oneOf',
value: [
'all',
'parent',
'child',
],
},
},
{
description: `勾选或取消勾选复选框时触发的回调函数␊
@param {Array} checkedKeys 勾选复选框节点key的数组␊
@param {Object} extra 额外参数␊
@param {Array} extra.checkedNodes 勾选复选框节点的数组␊
@param {Array} extra.checkedNodesPositions 包含有勾选复选框节点和其位置的对象的数组␊
@param {Array} extra.indeterminateKeys 半选复选框节点 key 的数组␊
@param {Object} extra.node 当前操作的节点␊
@param {Boolean} extra.checked 当前操作是否是勾选`,
name: 'onCheck',
propType: 'func',
},
{
defaultValue: false,
description: '是否默认展开所有节点',
name: 'defaultExpandAll',
propType: 'bool',
},
{
defaultValue: true,
description: '是否自动展开父节点,建议受控时设置为false',
name: 'autoExpandParent',
propType: 'bool',
},
{
description: `展开或收起节点时触发的回调函数␊
@param {Array} expandedKeys 展开的节点key的数组␊
@param {Object} extra 额外参数␊
@param {Object} extra.node 当前操作的节点␊
@param {Boolean} extra.expanded 当前操作是否是展开`,
name: 'onExpand',
propType: 'func',
},
{
defaultValue: false,
description: '是否支持编辑节点内容',
name: 'editable',
propType: 'bool',
},
{
description: `编辑节点内容完成时触发的回调函数␊
@param {String} key 编辑节点的 key␊
@param {String} label 编辑节点完成时节点的文本␊
@param {Object} node 当前编辑的节点`,
name: 'onEditFinish',
propType: 'func',
},
{
defaultValue: false,
description: '是否支持拖拽节点',
name: 'draggable',
propType: 'bool',
},
{
description: `开始拖拽节点时触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 拖拽的节点`,
name: 'onDragStart',
propType: 'func',
},
{
description: `拖拽节点进入目标节点时触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 目标节点␊
@param {Array} info.expandedKeys 当前展开的节点key的数组`,
name: 'onDragEnter',
propType: 'func',
},
{
description: `拖拽节点在目标节点上移动的时候触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 目标节点`,
name: 'onDragOver',
propType: 'func',
},
{
description: `拖拽节点离开目标节点时触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 目标节点`,
name: 'onDragLeave',
propType: 'func',
},
{
description: `拖拽节点拖拽结束时触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 目标节点`,
name: 'onDragEnd',
propType: 'func',
},
{
description: `拖拽节点放入目标节点内或前后触发的回调函数␊
@param {Object} info 拖拽信息␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 目标节点␊
@param {Object} info.dragNode 拖拽的节点␊
@param {Array} info.dragNodesKeys 拖拽的节点和其子节点 key 的数组␊
@param {Number} info.dropPosition 放置位置,-1代表当前节点前,0代表当前节点里,1代表当前节点后`,
name: 'onDrop',
propType: 'func',
},
{
defaultValue: Function {},
description: `节点是否可被作为拖拽的目标节点␊
@param {Object} info 拖拽信息␊
@param {Object} info.node 目标节点␊
@param {Object} info.dragNode 拖拽的节点␊
@param {Array} info.dragNodesKeys 拖拽的节点和其子节点 key 的数组␊
@param {Number} info.dropPosition 放置位置,-1代表当前节点前,0代表当前节点里,1代表当前节点后␊
@return {Boolean} 是否可以被当作目标节点`,
name: 'canDrop',
propType: 'func',
},
{
description: `异步加载数据的函数␊
@param {Object} node 被点击展开的节点`,
name: 'loadData',
propType: 'func',
},
{
description: `按需筛选高亮节点␊
@param {Object} node 待筛选的节点␊
@return {Boolean} 是否被筛选中`,
name: 'filterTreeNode',
propType: 'func',
},
{
description: `右键点击节点时触发的回调函数␊
@param {Object} info 信息对象␊
@param {Object} info.event 事件对象␊
@param {Object} info.node 点击的节点`,
name: 'onRightClick',
propType: 'func',
},
{
defaultValue: false,
description: '设置节点是否占满剩余空间,一般用于统一在各节点右侧添加元素(借助 flex 实现,暂时只支持 ie10+)',
name: 'isLabelBlock',
propType: 'bool',
},
{
defaultValue: false,
description: '设置节点是否占满一行',
name: 'isNodeBlock',
propType: {
type: 'oneOfType',
value: [
'bool',
'object',
],
},
},
{
defaultValue: true,
description: '是否开启展开收起动画',
name: 'animation',
propType: 'bool',
},
{
description: '当前获得焦点的子菜单或菜单项 key 值',
name: 'focusedKey',
propType: 'string',
},
{
description: `渲染子节点␊
@param {Array<ReactNode>} nodes 所有的子节点␊
@return {ReactNode} 返回节点`,
name: 'renderChildNodes',
propType: 'func',
},
{
defaultValue: true,
name: 'focusable',
propType: 'bool',
},
{
defaultValue: false,
name: 'autoFocus',
propType: 'bool',
},
{
name: 'onItemFocus',
propType: 'func',
},
{
name: 'onBlur',
propType: 'func',
},
{
name: 'onItemKeyDown',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TreeNode',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Tree',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Node',
version: '1.19.18',
},
props: [
{
name: '_key',
propType: 'string',
},
{
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '树节点',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: '---',
description: '节点文本内容',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '单独设置是否支持选中,覆盖 Tree 的 selectable',
name: 'selectable',
propType: 'bool',
},
{
description: '单独设置是否出现复选框,覆盖 Tree 的 checkable',
name: 'checkable',
propType: 'bool',
},
{
description: '单独设置是否支持编辑,覆盖 Tree 的 editable',
name: 'editable',
propType: 'bool',
},
{
description: '单独设置是否支持拖拽,覆盖 Tree 的 draggable',
name: 'draggable',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁止节点响应',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: false,
description: '是否禁止勾选节点复选框',
name: 'checkboxDisabled',
propType: 'bool',
},
{
defaultValue: false,
description: '是否是叶子节点,设置loadData时生效',
name: 'isLeaf',
propType: 'bool',
},
{
name: 'root',
propType: 'object',
},
{
name: 'eventKey',
propType: 'string',
},
{
name: 'pos',
propType: 'string',
},
{
name: 'expanded',
propType: 'bool',
},
{
name: 'selected',
propType: 'bool',
},
{
name: 'checked',
propType: 'bool',
},
{
name: 'indeterminate',
propType: 'bool',
},
{
name: 'dragOver',
propType: 'bool',
},
{
name: 'dragOverGapTop',
propType: 'bool',
},
{
name: 'dragOverGapBottom',
propType: 'bool',
},
{
name: 'parentNode',
propType: 'object',
},
{
name: 'onKeyDown',
propType: 'func',
},
{
defaultValue: 1,
name: 'size',
propType: 'number',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'TreeSelect',
docUrl: '',
npm: {
destructuring: true,
exportName: 'TreeSelect',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'pure',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
description: '树节点',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'medium',
description: '选择框大小',
name: 'size',
propType: {
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
},
{
description: '选择框占位符',
name: 'placeholder',
propType: 'string',
},
{
defaultValue: false,
description: '是否禁用',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有下拉箭头',
name: 'hasArrow',
propType: 'bool',
},
{
defaultValue: true,
description: '是否有边框',
name: 'hasBorder',
propType: 'bool',
},
{
defaultValue: false,
description: '是否有清空按钮',
name: 'hasClear',
propType: 'bool',
},
{
description: '自定义内联 label',
name: 'label',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '是否只读,只读模式下可以展开弹层但不能选择',
name: 'readOnly',
propType: 'bool',
},
{
defaultValue: true,
description: '下拉框是否与选择器对齐',
name: 'autoWidth',
propType: 'bool',
},
{
defaultValue: Function {},
description: `选中值改变时触发的回调函数␊
@param {String|Array} value 选中的值,单选时返回单个值,多选时返回数组␊
@param {Object|Array} data 选中的数据,包括 value, label, pos, key属性,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点`,
name: 'onChange',
propType: 'func',
},
{
defaultValue: false,
description: '是否显示搜索框',
name: 'showSearch',
propType: 'bool',
},
{
defaultValue: Function {},
description: `在搜索框中输入时触发的回调函数␊
@param {String} keyword 输入的关键字`,
name: 'onSearch',
propType: 'func',
},
{
defaultValue: Function {},
name: 'onSearchClear',
propType: 'func',
},
{
defaultValue: 'Not Found',
description: '无数据时显示内容',
name: 'notFoundContent',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
description: '是否支持多选',
name: 'multiple',
propType: 'bool',
},
{
defaultValue: false,
description: '下拉框中的树是否支持勾选节点的复选框',
name: 'treeCheckable',
propType: 'bool',
},
{
defaultValue: false,
description: '下拉框中的树勾选节点复选框是否完全受控(父子节点选中状态不再关联)',
name: 'treeCheckStrictly',
propType: 'bool',
},
{
defaultValue: 'parent',
description: `定义选中时回填的方式␊
@enumdesc 返回所有选中的节点, 父子节点都选中时只返回父节点, 父子节点都选中时只返回子节点`,
name: 'treeCheckedStrategy',
propType: {
type: 'oneOf',
value: [
'all',
'parent',
'child',
],
},
},
{
defaultValue: false,
description: '下拉框中的树是否默认展开所有节点',
name: 'treeDefaultExpandAll',
propType: 'bool',
},
{
description: `下拉框中的树异步加载数据的函数,使用请参考[Tree的异步加载数据Demo](https://fusion.design/component/tree)␊
@param {ReactElement} node 被点击展开的节点`,
name: 'treeLoadData',
propType: 'func',
},
{
defaultValue: undefined,
description: '透传到 Tree 的属性对象',
name: 'treeProps',
propType: 'object',
},
{
defaultValue: false,
description: '初始下拉框是否显示',
name: 'defaultVisible',
propType: 'bool',
},
{
description: '当前下拉框是否显示',
name: 'visible',
propType: 'bool',
},
{
defaultValue: Function {},
description: `下拉框显示或关闭时触发事件的回调函数␊
@param {Boolean} visible 是否显示␊
@param {String} type 触发显示关闭的操作类型`,
name: 'onVisibleChange',
propType: 'func',
},
{
description: '下拉框自定义样式对象',
name: 'popupStyle',
propType: 'object',
},
{
description: '下拉框样式自定义类名',
name: 'popupClassName',
propType: 'string',
},
{
description: '下拉框挂载的容器节点',
name: 'popupContainer',
propType: 'any',
},
{
description: '透传到 Popup 的属性对象',
name: 'popupProps',
propType: 'object',
},
{
description: '是否跟随滚动',
name: 'followTrigger',
propType: 'bool',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {Array<data>} value 选择值 { label: , value:}`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Typography',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Typography',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'article',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Paragraph',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Typography',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Paragraph',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: 'p',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
defaultValue: 'long',
name: 'type',
},
{
defaultValue: 'medium',
name: 'size',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Text',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Typography',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Text',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
description: '添加删除线样式',
name: 'delete',
propType: 'bool',
},
{
defaultValue: false,
description: '添加标记样式',
name: 'mark',
propType: 'bool',
},
{
defaultValue: false,
description: '添加下划线样式',
name: 'underline',
propType: 'bool',
},
{
defaultValue: false,
description: '是否加粗',
name: 'strong',
propType: 'bool',
},
{
defaultValue: false,
description: '添加代码样式',
name: 'code',
propType: 'bool',
},
{
defaultValue: 'span',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Upload',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
description: '上传的地址',
name: 'action',
propType: 'string',
},
{
description: '文件列表',
name: 'value',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '默认文件列表',
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
description: '上传按钮形状',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'card',
],
},
},
{
description: `上传列表的样式␊
@enumdesc 文字, 图文, 卡片`,
name: 'listType',
propType: {
type: 'oneOf',
value: [
'text',
'image',
'card',
],
},
},
{
name: 'list',
propType: 'any',
},
{
description: '文件名字段',
name: 'name',
propType: 'string',
},
{
description: '上传额外传参',
name: 'data',
propType: {
type: 'oneOfType',
value: [
'object',
'func',
],
},
},
{
description: `数据格式化函数,配合自定义 action 使用,参数为服务器的响应数据,详见 [formatter](#formater)␊
@param {Object} response 返回␊
@param {File} file 文件对象`,
name: 'formatter',
propType: 'func',
},
{
defaultValue: Infinity,
description: '最大文件上传个数',
name: 'limit',
propType: 'number',
},
{
description: '设置上传超时,单位ms',
name: 'timeout',
propType: 'number',
},
{
description: '可选参数,是否支持拖拽上传,`ie10+` 支持。',
name: 'dragable',
propType: 'bool',
},
{
defaultValue: true,
name: 'closable',
propType: 'bool',
},
{
description: '可选参数,是否本地预览',
name: 'useDataURL',
propType: 'bool',
},
{
description: '可选参数,是否禁用上传功能',
name: 'disabled',
propType: 'bool',
},
{
description: '选择文件回调',
name: 'onSelect',
propType: 'func',
},
{
description: '上传中',
name: 'onProgress',
propType: 'func',
},
{
description: `上传文件改变时的状态␊
@param {Object} info 文件事件对象`,
name: 'onChange',
propType: 'func',
},
{
description: `可选参数,上传成功回调函数,参数为请求下响应信息以及文件␊
@param {Object} file 文件␊
@param {Array<Object>} value 值`,
name: 'onSuccess',
propType: 'func',
},
{
description: `可选参数, 用于校验文件,afterSelect仅在 autoUpload=false 的时候生效,autoUpload=true时,可以使用beforeUpload完全可以替代该功能.␊
@param {Object} file␊
@returns {Boolean} 返回false会阻止上传,其他则表示正常`,
name: 'afterSelect',
propType: 'func',
},
{
description: `移除文件回调函数␊
@param {Object} file 文件␊
@returns {Boolean|Promise} 返回 false、Promise.resolve(false)、 Promise.reject() 将阻止文件删除`,
name: 'onRemove',
propType: 'func',
},
{
description: `可选参数,上传失败回调函数,参数为上传失败的信息、响应信息以及文件␊
@param {Object} file 出错的文件␊
@param {Array} value 当前值`,
name: 'onError',
propType: 'func',
},
{
description: `可选参数, 详见 [beforeUpload](#beforeUpload)␊
@param {Object} file 所有文件␊
@param {Object} options 参数␊
@returns {Boolean|Object|Promise} 返回值作用见demo`,
name: 'beforeUpload',
propType: 'func',
},
{
description: '放文件',
name: 'onDrop',
propType: 'func',
},
{
description: '自定义class',
name: 'className',
propType: 'string',
},
{
description: '自定义内联样式',
name: 'style',
propType: 'object',
},
{
description: '子元素',
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: true,
description: '自动上传',
name: 'autoUpload',
propType: 'bool',
},
{
description: `自定义上传方法␊
@param {Object} option␊
@return {Object} object with abort method`,
name: 'request',
propType: 'func',
},
{
description: '透传给Progress props',
name: 'progressProps',
propType: 'object',
},
{
name: 'rtl',
propType: 'bool',
},
{
description: '是否为预览态',
name: 'isPreview',
propType: 'bool',
},
{
description: `预览态模式下渲染的内容␊
@param {number} value 评分值`,
name: 'renderPreview',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Card',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Card',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'children',
propType: 'object',
},
{
name: 'value',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'object',
],
},
},
{
name: 'defaultValue',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'object',
],
},
},
{
description: '点击图片回调',
name: 'onPreview',
propType: 'func',
},
{
description: '改变时候的回调',
name: 'onChange',
propType: 'func',
},
{
description: '点击移除的回调',
name: 'onRemove',
propType: 'func',
},
{
description: '取消上传的回调',
name: 'onCancel',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Dragger',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Dragger',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'shape',
propType: 'string',
},
{
name: 'onDragOver',
propType: 'func',
},
{
name: 'onDragLeave',
propType: 'func',
},
{
name: 'onDrop',
propType: 'func',
},
{
name: 'limit',
propType: 'number',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'listType',
propType: 'string',
},
{
name: 'timeout',
propType: 'number',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Selecter',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Selecter',
version: '1.19.18',
},
props: [
{
name: 'id',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'className',
propType: 'string',
},
{
description: '是否禁用上传功能',
name: 'disabled',
propType: 'bool',
},
{
defaultValue: false,
description: '是否支持多选文件,`ie10+` 支持。开启后按住 ctrl 可选择多个文件',
name: 'multiple',
propType: 'bool',
},
{
description: '是否支持拖拽上传,`ie10+` 支持。',
name: 'dragable',
propType: 'bool',
},
{
description: '接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)',
name: 'accept',
propType: 'string',
},
{
description: '文件选择回调',
name: 'onSelect',
propType: 'func',
},
{
description: '拖拽经过回调',
name: 'onDragOver',
propType: 'func',
},
{
description: '拖拽离开回调',
name: 'onDragLeave',
propType: 'func',
},
{
description: '拖拽完成回调',
name: 'onDrop',
propType: 'func',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'file',
name: 'name',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Card',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'ImageUpload',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'children',
propType: 'object',
},
{
name: 'value',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'object',
],
},
},
{
name: 'defaultValue',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'array',
},
'object',
],
},
},
{
description: '点击图片回调',
name: 'onPreview',
propType: 'func',
},
{
description: '改变时候的回调',
name: 'onChange',
propType: 'func',
},
{
description: '点击移除的回调',
name: 'onRemove',
propType: 'func',
},
{
description: '取消上传的回调',
name: 'onCancel',
propType: 'func',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Dragger',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'DragUpload',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
description: '样式前缀',
name: 'prefix',
propType: 'string',
},
{
name: 'locale',
propType: 'object',
},
{
name: 'shape',
propType: 'string',
},
{
name: 'onDragOver',
propType: 'func',
},
{
name: 'onDragLeave',
propType: 'func',
},
{
name: 'onDrop',
propType: 'func',
},
{
name: 'limit',
propType: 'number',
},
{
name: 'className',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'defaultValue',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'listType',
propType: 'string',
},
{
name: 'timeout',
propType: 'number',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'List',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Upload',
main: 'src/index.js',
package: '@alifd/next',
subName: 'List',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '多语言',
name: 'locale',
propType: 'object',
},
{
defaultValue: 'text',
description: '文件列表,数据格式请参考 文件对象',
name: 'listType',
propType: {
type: 'oneOf',
value: [
'text',
'image',
'card',
],
},
},
{
defaultValue: [],
description: '文件列表',
name: 'value',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
defaultValue: false,
name: 'closable',
propType: 'bool',
},
{
description: '删除文件回调(支持Promise)',
name: 'onRemove',
propType: 'func',
},
{
description: '取消上传回调(支持Promise)',
name: 'onCancel',
propType: 'func',
},
{
description: '头像加载出错回调',
name: 'onImageError',
propType: 'func',
},
{
description: 'listType=card时点击图片回调',
name: 'onPreview',
propType: 'func',
},
{
description: '自定义额外渲染',
name: 'extraRender',
propType: 'func',
},
{
defaultValue: undefined,
description: '透传给Progress props',
name: 'progressProps',
propType: 'object',
},
{
name: 'children',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'uploader',
propType: 'any',
},
{
description: '可选参数,是否本地预览',
name: 'useDataURL',
propType: 'bool',
},
{
name: 'rtl',
propType: 'bool',
},
{
name: 'isPreview',
propType: 'bool',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'VirtualList',
docUrl: '',
npm: {
destructuring: true,
exportName: 'VirtualList',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '渲染的子节点',
name: 'children',
propType: 'any',
},
{
defaultValue: 1,
description: '最小加载数量',
name: 'minSize',
propType: 'number',
},
{
defaultValue: 10,
description: '一屏数量',
name: 'pageSize',
propType: 'number',
},
{
description: '父渲染函数,默认为 (items, ref) => <ul ref={ref}>{items}</ul>',
name: 'itemsRenderer',
propType: 'func',
},
{
defaultValue: 100,
description: '缓冲区高度',
name: 'threshold',
propType: 'number',
},
{
description: '获取item高度的函数',
name: 'itemSizeGetter',
propType: 'func',
},
{
defaultValue: 0,
description: '设置跳转位置,需要设置 itemSizeGetter 才能生效, 不设置认为元素等高并取第一个元素高度作为默认高',
name: 'jumpIndex',
propType: 'number',
},
{
name: 'className',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Divider',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Divider',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: false,
description: '是否为虚线',
name: 'dashed',
propType: 'bool',
},
{
defaultValue: 'hoz',
description: '线是水平还是垂直类型',
name: 'direction',
propType: {
type: 'oneOf',
value: [
'hoz',
'ver',
],
},
},
{
defaultValue: 'center',
description: '分割线标题的位置',
name: 'orientation',
propType: {
type: 'oneOf',
value: [
'left',
'right',
'center',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Avatar',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Avatar',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
{
name: 'className',
propType: 'string',
},
{
defaultValue: 'medium',
description: '头像的大小',
name: 'size',
propType: {
type: 'oneOfType',
value: [
{
type: 'oneOf',
value: [
'small',
'medium',
'large',
],
},
'number',
],
},
},
{
defaultValue: 'circle',
description: '头像的形状',
name: 'shape',
propType: {
type: 'oneOf',
value: [
'circle',
'square',
],
},
},
{
description: 'icon 类头像的图标类型,可设为 Icon 的 `type` 或 `ReactNode`',
name: 'icon',
propType: {
type: 'oneOfType',
value: [
{
type: 'instanceOf',
value: 'node',
},
'string',
],
},
},
{
description: '图片类头像的资源地址',
name: 'src',
propType: 'string',
},
{
description: '图片加载失败的事件,返回 false 会关闭组件默认的 fallback 行为',
name: 'onError',
propType: 'func',
},
{
description: '图像无法显示时的 alt 替代文本',
name: 'alt',
propType: 'string',
},
{
description: '图片类头像响应式资源地址',
name: 'srcSet',
propType: 'string',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'ResponsiveGrid',
docUrl: '',
npm: {
destructuring: true,
exportName: 'ResponsiveGrid',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'className',
propType: 'any',
},
{
defaultValue: 'desktop',
description: `设备,用来做自适应,默认为 PC␊
@enumdesc 手机, 平板, PC`,
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
{
name: 'rows',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
description: '分为几列, 默认是 12 列',
name: 'columns',
propType: {
type: 'oneOfType',
value: [
'number',
'string',
],
},
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Cell',
docUrl: '',
npm: {
destructuring: true,
exportName: 'ResponsiveGrid',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Cell',
version: '1.19.18',
},
props: [
{
defaultValue: 'desktop',
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
{
description: '横向,占据几列',
name: 'colSpan',
propType: {
type: 'oneOfType',
value: [
'number',
'object',
],
},
},
{
description: '纵向,占据几行',
name: 'rowSpan',
propType: 'number',
},
{
defaultValue: 'div',
description: '设置标签类型',
name: 'component',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'Box',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Box',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
name: 'style',
propType: 'object',
},
{
name: 'className',
propType: 'any',
},
{
defaultValue: 'column',
description: `布局方向,默认为 column ,一个元素占据一整行␊
@default column`,
name: 'direction',
propType: {
type: 'oneOf',
value: [
'row',
'column',
],
},
},
{
defaultValue: false,
description: '是否折行',
name: 'wrap',
propType: 'bool',
},
{
description: '沿着主轴方向,子元素们的排布关系 (兼容性同 justify-content )',
name: 'justify',
propType: {
type: 'oneOf',
value: [
'flex-start',
'center',
'flex-end',
'space-between',
'space-around',
],
},
},
{
description: '垂直主轴方向,子元素们的排布关系 (兼容性同 align-items )',
name: 'align',
propType: {
type: 'oneOf',
value: [
'flex-start',
'center',
'flex-end',
'baseline',
'stretch',
],
},
},
{
name: 'device',
propType: {
type: 'oneOf',
value: [
'phone',
'tablet',
'desktop',
],
},
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'List',
docUrl: '',
npm: {
destructuring: true,
exportName: 'List',
main: 'src/index.js',
package: '@alifd/next',
subName: '',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
defaultValue: false,
name: 'rtl',
propType: 'bool',
},
{
description: '列表头部',
name: 'header',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '列表尾部',
name: 'footer',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
defaultValue: 'medium',
description: '列表尺寸',
name: 'size',
propType: {
type: 'oneOf',
value: [
'medium',
'small',
],
},
},
{
defaultValue: true,
description: '是否显示分割线',
name: 'divider',
propType: 'bool',
},
{
name: 'className',
propType: 'string',
},
{
name: 'children',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
{
componentName: 'ListItem',
docUrl: '',
npm: {
destructuring: true,
exportName: 'List',
main: 'src/index.js',
package: '@alifd/next',
subName: 'Item',
version: '1.19.18',
},
props: [
{
defaultValue: 'next-',
name: 'prefix',
propType: 'string',
},
{
description: '列表元素的标题',
name: 'title',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '列表元素的描述内容',
name: 'description',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '列表元素的头像 / 图标 / 图片内容',
name: 'media',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
description: '额外内容',
name: 'extra',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'className',
propType: 'any',
},
],
screenshot: '',
title: '@alifd/next',
},
]
materialize multiple exported component by local
Snapshot 1
[
{
componentName: 'AIMakeBlank',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakeBlank',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleLayout',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleBackground',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleFlexLayout',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
{
name: 'id',
propType: 'string',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'AIMakeIcon',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakeIcon',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'className',
propType: 'string',
},
{
name: 'iconClassName',
propType: 'string',
},
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleText',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleBackground',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'AIMakeImage',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakeImage',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'AIMakeLink',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakeLink',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleText',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleLayout',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleBackground',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'AIMakePlaceholder',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakePlaceholder',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleLayout',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'AIMakeText',
docUrl: '',
npm: {
destructuring: true,
exportName: 'AIMakeText',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'type',
propType: 'string',
},
{
name: 'styleBoxModel',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleText',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleLayout',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'styleBackground',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
{
componentName: 'Root',
docUrl: '',
npm: {
destructuring: true,
exportName: 'Root',
main: 'es/index.js',
package: 'multiple-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'style',
propType: 'object',
},
],
screenshot: '',
title: 'multiple-exported-component',
},
]
materialize single exported component by local
Snapshot 1
[
{
componentName: 'Demo',
docUrl: '',
npm: {
destructuring: false,
exportName: 'default',
main: 'es/index.js',
package: 'single-exported-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'optionalArray',
propType: {
type: 'instanceOf',
value: 'array',
},
},
{
name: 'optionalBool',
propType: 'bool',
},
{
name: 'optionalFunc',
propType: 'func',
},
{
defaultValue: 123,
name: 'optionalNumber',
propType: 'number',
},
{
name: 'optionalObject',
propType: 'object',
},
{
name: 'optionalString',
propType: 'string',
},
{
name: 'optionalSymbol',
propType: 'symbol',
},
{
name: 'optionalNode',
propType: {
type: 'instanceOf',
value: 'node',
},
},
{
name: 'optionalElement',
propType: {
type: 'instanceOf',
value: 'element',
},
},
{
name: 'optionalElementType',
propType: {
type: 'instanceOf',
value: 'elementType',
},
},
{
name: 'optionalMessage',
propType: {
type: 'instanceOf',
value: 'Demo',
},
},
{
name: 'optionalEnum',
propType: {
type: 'oneOf',
value: [
'News',
'Photos',
],
},
},
{
name: 'optionalUnion',
propType: {
type: 'oneOfType',
value: [
'string',
'number',
{
type: 'instanceOf',
value: 'Demo',
},
],
},
},
{
name: 'optionalObjectOf',
propType: {
type: 'objectOf',
value: 'number',
},
},
{
name: 'optionalObjectWithShape',
propType: {
type: 'shape',
value: [
{
name: 'optionalProperty',
propType: 'string',
},
{
name: 'requiredProperty',
propType: {
isRequired: true,
type: 'number',
},
},
],
},
},
{
name: 'optionalObjectWithShape2',
propType: {
isRequired: true,
type: 'shape',
value: [
{
name: 'optionalProperty',
propType: 'string',
},
{
name: 'requiredProperty',
propType: {
isRequired: true,
type: 'number',
},
},
],
},
},
{
name: 'optionalObjectWithStrictShape',
propType: {
type: 'exact',
value: [
{
name: 'optionalProperty',
propType: 'string',
},
{
name: 'requiredProperty',
propType: {
isRequired: true,
type: 'number',
},
},
],
},
},
{
name: 'requiredFunc',
propType: {
isRequired: true,
type: 'func',
},
},
{
name: 'requiredAny',
propType: {
isRequired: true,
type: 'any',
},
},
],
screenshot: '',
title: 'single-exported-component',
},
]
ts component by local
Snapshot 1
[
{
componentName: 'App',
docUrl: '',
npm: {
destructuring: false,
exportName: 'default',
main: 'src/index.tsx',
package: 'ts-component',
subName: '',
version: '1.0.0',
},
props: [
{
name: 'str',
propType: 'string',
},
{
name: 'num',
propType: {
isRequired: true,
type: 'number',
},
},
{
name: 'gender',
propType: {
isRequired: true,
type: 'instanceOf',
value: 'Gender',
},
},
{
name: 'any',
propType: {
isRequired: true,
type: 'any',
},
},
{
name: 'bool',
propType: {
isRequired: true,
type: 'bool',
},
},
{
name: 'tuple',
propType: {
isRequired: true,
type: 'oneOf',
value: [
1,
'str',
true,
],
},
},
{
name: 'enum',
propType: {
isRequired: true,
type: 'oneOfType',
value: [
'red',
'yellow',
'green',
],
},
},
{
name: 'arr',
propType: {
isRequired: true,
type: 'arrayOf',
},
},
{
name: 'obj',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'objOf',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'exact',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'empty',
propType: {
isRequired: true,
type: 'object',
},
},
{
name: 'node',
propType: 'node',
},
{
name: 'element',
propType: 'element',
},
{
name: 'elementType',
propType: 'elementType',
},
{
name: 'instance',
propType: {
isRequired: true,
type: 'instanceOf',
value: 'Props',
},
},
],
screenshot: '',
title: 'ts-component',
},
{
componentName: 'SubModule',
docUrl: '',
npm: {
destructuring: false,
exportName: 'default',
main: 'src/index.tsx',
package: 'ts-component',
subName: 'SubModule',
version: '1.0.0',
},
props: [
{
name: 'name',
propType: 'string',
},
],
screenshot: '',
title: 'ts-component',
},
]