API Reference live_antd v0.1.0

Modules

Alert component for feedback.

API

Table

  • [ ] bordered Whether to show all table borders boolean false
  • [ ] columns: Columns of table ColumnsType[] -
  • [ ] components: Override default table elements TableComponents -
  • [ ] dataSource: Data record array to be displayed object[] -
  • [ ] expandable: Config expandable content expandable -
  • [ ] footer: Table footer renderer function(currentPageData) -
  • [ ] getPopupContainer: The render container of dropdowns in table (triggerNode) => HTMLElement () => TableHtmlElement
  • [ ] loading: Loading status of table boolean | object (more) false
  • [ ] locale: The i18n text including filter, sort, empty text, etc object filterConfirm: Ok
  • [ ] pagination: Config of pagination. You can ref table pagination config or full pagination document, hide it by setting it to false object -
  • [ ] rowClassName: Row's className function(record, index): string -
  • [ ] rowKey: Row's unique key, could be a string or function that returns a string string | function(record): string key
  • [ ] rowSelection: Row selection config object -
  • [ ] scroll: Whether the table can be scrollable, config object -
  • [ ] showHeader: Whether to show table header boolean true
  • [ ] showSorterTooltip: The header show next sorter direction tooltip boolean true
  • [ ] size: Size of table default | middle | small default
  • [ ] sortDirections: Supported sort way, could be ascend, descend Array [ascend, descend]
  • [ ] sticky: Set sticky header and scroll bar boolean | {offsetHeader?: number, offsetScroll?: number, getContainer?: () => HTMLElement} - 4.6.0 (getContainer: 4.7.0)
  • [ ] summary: Summary content (currentData) => ReactNode -
  • [ ] tableLayout: The table-layout attribute of table element - | auto | fixed -
  • [ ] fixed: when header/columns are fixed, or using column.ellipsis
  • [ ] title: Table title renderer function(currentPageData) -
  • [ ] onChange: Callback executed when pagination, filters or sorter is changed function(pagination, filters, sorter, extra: { currentDataSource: [], action: paginate | sort | filter }) -
  • [ ] onHeaderRow: Set props on per header row function(column, index) -
  • [ ] onRow: Set props on per row

Example

<AntdTable

Avatars can be used to represent people or objects. It supports images, Icons, or letters.

Makes it easy to go back to the top of the page.

Small numerical value or status descriptor for UI elements.

A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy.

Button Component.

Simple rectangular container.

Cascade selection box.

Checkbox Component.

A content area which can be collapsed and expanded.

To select or input a date.

A panel which slides in from the edge of the screen.

Empty state placeholder.

Defines a form field.

<Col span={12} /> <Col span={6} /> <Col span={6} />

Semantic vector graphics.

A basic widget for getting the user input is a text field. Keyboard and mouse can be used for providing or changing data.

Enter a number within certain range with the mouse or keyboard.

Handling the overall layout of a page.

Simple List Components.

Display global messages as feedback in response to user operations.

Modal dialogs.

API

  • [ ] avatar: Avatar next to the title bar AvatarProps -
  • [ ] backIcon: Custom back icon, if false the back icon will not be displayed ReactNode | boolean <ArrowLeft />
  • [x] breadcrumb: Breadcrumb configuration Breadcrumb -
  • [x] extra: Operating area, at the end of the line of the title line ReactNode -
  • [ ] footer: PageHeader's footer, generally used to render TabBar ReactNode -
  • [x] ghost: PageHeader type, will change background color boolean true
  • [x] subTitle: Custom subtitle text ReactNode -
  • [ ] tags: Tag list next to title Tag[] | Tag -
  • [x] title: Custom title text ReactNode -
  • [ ] onBack: Back icon click event () => void

Example

<PageHeader

A long list can be divided into several pages using Pagination, and only one page will be loaded at a time.

A simple and compact confirmation dialog of an action.

The floating card popped by clicking or hovering.

Display the current progress of an operation flow.

Radio Component.

Rate component.

Used to feed back the results of a series of operational tasks.

search component.

Select component to select value from options.

Provide a placeholder while you wait for content to load, or to visualise content that doesn't exist yet.

相邻组件的布局工具, 比如两个按钮之间的间隔,自动化处理。

A spinner for displaying loading state of a page or a section.

Switching Selector.

A table for normal way (it's not antd style.)

Defines a column for the parent table component. The column instance is automatically added to the table's cols slot.

Tabs make it easy to switch between different views.

Tag for categorizing or markup.

A simple text popup tip.

Upload file by selecting or dragging.

Properties