0.1.14 • Published 2 years ago

@bis0212/listcomponents v0.1.14

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

@bis0212/ListComponents

How To Install

# NPM
npm npm i @bis0212/listcomponents

# Yarn
yarn add @bis0212/listcomponents

Example

 import ListComponent from "@bis0212/listcomponents";
    ...
 return <ListComponent
   header = {[]}
   items = {[]}
   resizeWidth = {3}
   maximumRowCount = {10}
   totalCount={30}
   useAddPopup = {true}
   useSearchFilter = {true}
   useFolderPath = {true}
   usePagination = {true}
   onChangeColumnWidth = {(column) => {}}
   onChangeColumnOrder = {(column) => {}}
   onAddFolder = {(currentFolder) => {}}
   onMoveRow = {(dragIndex, hoverIndex) => {}}
   onMoveItemToFolder = {(checkList, row) => {}}
   onChangeHiddenColumn = {(column) => {}}
   onChangeCurrentPage = {(page) => {}}
   onChangePath = {(path) => {}}
   onUpdateItem = {(item) => {}}
   onDeleteItem = {(item) => {}}
   onClickItem ={(item) => {}}
    />;

Props

KeyRequiredTypeDescDefault
headerVArrayDefine Column Information
itemsVArrayDefine Row Information
resizeWidthNumberResizing border width10
maximumRowCountNumberdisplay Item Count100
useAddPopupBooleanDisplay Add Utility Buttontrue
useSearchFilterBooleanDisplay Search Filtertrue
useFolderPathBooleanDisplay Folder Pathtrue
usePaginationBooleanDisplay Paginationtrue
useColumnBooleanDisplay Columntrue
onChangeColumnWidthFunctionCallback when changed Column Width
onChangeColumnOrderFunctionCallback when changed Column Order
onAddFolderFunctionCallback when Add Folder
onMoveRowFunctionCallback when Move Row
onMoveItemToFolderFunctionCallback when Item Move into Folder
onChangeHiddenColumnFunctionCallback when Change Hidden Column
onChangeCurrentPageFunctionCallback when Change Current Page
onChangePathFunctionCallback when Change Path
onUpdateItemFunctionCallback when Update Item
onDeleteItemFunctionCallback when Delete Item
onClickItemFunctionCallback when Click Item

header - Props

KeyRequiredTypeExampleDefault
headerVStringName, Title, etc ...
accessorVStringname, title, etc ...
maxWidthNumber50, 300, etc...
minWidthNumber50, 300, etc...
widthNumber50, 300, etc...150
disableResizingBooleantrue, falsefalse
showBooleantrue, falsefalse
disableSortByBooleantrue, falsefalse

items - Default Props

KeyRequiredTypeExample
nameVString"Test_File", "Test_Folder" etc ...
extensionVString"folder", "file", "note", "pdf" etc...
lastworkVDatenew Date()
pathVString'home', 'home/Test_Folder', etc ...
statusVNumber0, 1, 2 (0 - Not Use / 1 - Can Use / 2 - Loading)

Example

const items = [
  {
    name: "Cannot_Use_File",
    extension: "pdf",
    lastwork: new Date(),
    path: "home",
    status: 0,
  },
  {
    name: "Test_Folder",
    extension: "folder",
    lastwork: new Date(),
    path: "home",
    status: 1,
  },
  {
    name: "Test_File",
    extension: "file",
    lastwork: new Date(),
    path: "home",
    status: 2,
  },
];

const columns = [
  {
    Header: "Name",
    accessor: "name", // accessor is the "key" in the data
  },
  {
    Header: "Extension",
    accessor: "extension",
  },
  {
    Header: "LastWork",
    accessor: "name",
  },
  {
    Header: "Action",
    accessor: "action", // if you want some event
  },
];