Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 4.11 KB

README.md

File metadata and controls

80 lines (60 loc) · 4.11 KB
Raw

Please be aware that this component has been significantly updated in version 2.0. You can access the 1.0 release here. Bug fixes for version 1.0 will continue to be maintained..

Miller Columns

NPM version GitHub issues LICENCE

Miller Columns Component based on MUI.

Features

  • Easy to use, and only one required prop.
  • Implement scrolling loading data on a column by react-infinite-scroll-component.
  • Written in TypeScript to achieve good type support.

Installation

# Yarn
$ yarn add @mints/miller-columns

# Npm
$ npm install --save @mints/miller-columns

Usage

import { MillerColumns } from '@mints/miller-columns';

const request = () => {
  return {
    data: [],
    hasMore: false,
  };
};

export const TestComponent = () => {
  return <MillerColumns request={request} />;
};

Props

Prop Type Default Description
request (id?: IDType, params?: any) => Promise<RequestResType> Asynchronous method for getting data
rootId IDType Parameters of the first request
loading boolean true Cooperate with items control
items DataType[] item used to display in columns
style React.CSSProperties
bordered boolean false
theme { colorPrimary?: string; borderColor?: string; }
columnCount number 3 columns to display in a container
columnHeight number columns height (control scrolling)
renderTitle (id: IDType) => React.ReactNode display column title
renderEnd (id: IDType) => React.ReactNode display column end
renderLoading (id: IDType) => React.ReactNode display column loading
renderError (errMsg: string) => React.ReactNode display column error
renderNoData (id: IDType) => React.ReactNode display column no data
selectable boolean false
mode single or multiple multiple Single select or multiple select
disabledIds IDType[] disabled ids
selectedIds IDType[] selected ids
onSelectedIds (ids: IDType[], data?: any[]) => void set selected ids

Start Example(Development)

$ yarn storybook

LICENSE

MIT