3.2.3 • Published 26 days ago

@forter/table v3.2.3

Weekly downloads
286
License
Apache-2.0
Repository
github
Last release
26 days ago

fc-sort-control

Provides a box with a search input and a scrollable div with checkboxes derived from the given objects

Properties

PropertyAttributeTypeDefaultDescription
objectsobjectsany[]The objects to display
searchTextsearchTextstring""The text inside the search box

Events

Event
change
sort

fc-sort-control

Provides a binary "Ascending/Descending" control for sortable tables.

Properties

PropertyAttributeTypeDefaultDescription
ascHTMLInputElementThe ascending control
checkedHTMLInputElementThe control for the selected direction
descHTMLInputElementThe descending control
directiondirection"asc" \| "desc" \| "none"The current sort direction
levellevelnumberThe sort level that will be displayed in a label
preventSecondarySortprevent-secondary-sortbooleanfalseWhether or not multiple column sort is enabled. example: true

Events

Event
sort

fc-table

A table accepting rows and columns. Rows represent actual data, columns describe the data types in the table.

Usage

<script>
   import '@forter/table';
</script>

<fc-table
      multi
      row-actions
      columns-draggable
      columns-removable
      columns=[{"insertable":true,"label":"First Name","fromKey":"firstName","pinned":true,"removable":false,"sortable":true,"sort":"asc","sortLevel":1,"type":"TEXT","filterable":true,"defaultVisibility":false,"defaultIndex":2,"filter":{"operator":"Matches","searchValues":["lala","abcdefghijklmnopqrstuvwxyz"]}},{"insertable":true,"editable":true,"required":true,"label":"Last Name","fromKey":"lastName","type":"TEXT","sort":"desc","sortLevel":2,"sortable":true,"defaultVisibility":true,"filterable":true,"filter":{"values":[{"label":"Yosef","checked":false,"color":"blue"},{"label":"Anati","checked":false,"color":"green"},{"label":"Weingart","checked":false,"color":"purple"},{"label":"Feder","checked":false,"color":"blue"}]}},{"label":"Payment Method","fromKey":"paymentMethod","type":"CUSTOM","renderer":"moneyRenderer","sortable":true,"defaultIndex":4,"visible":true,"filterable":true,"filter":{"values":[{"label":"PayPal","checked":true},{"label":"Amex","checked":false},{"label":"MasterCard","checked":false},{"label":"Visa","checked":true},{"label":"Bank Transfer","checked":true},{"label":"ApplePay","checked":true},{"label":"Google Pay","checked":false},{"label":"Android Pay","checked":false},{"label":"Amazon Pay","checked":false}],"valuesRenderer":"baba"}},{"label":"Text Column","fromKey":"textData","type":"TEXT","defaultIndex":3,"sortable":true,"visible":false,"filterable":true,"defaultVisibility":true},{"insertable":true,"multipleEditable":true,"editable":true,"required":true,"maskType":"number","label":"Order Amount","fromKey":"orderAmount","type":"TEXT","custom":"moneyRenderer","visible":true,"filterable":true,"defaultVisibility":true,"filter":{"type":"NUMBER","operator":"Greater Than","searchValues":["1"]}},{"maskType":"date","mask":"DD MMM YYYY HH:mm","required":true,"insertable":true,"editable":true,"label":"Date Column","fromKey":"dateData","type":"DATE","defaultVisibility":false},{"label":"Icon Column","fromKey":"iconData","type":"ICON","visible":true,"defaultIndex":5,"sortable":true,"filterable":true,"defaultVisibility":true}]
      rows=[{"firstName":false,"selected":true,"lastName":"Yosef","orderAmount":"12","rowActions":["claims","feedback"],"dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"selected":false,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]},{"firstName":"Ori","lastName":"Weingart","orderAmount":"17","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Visa","rowActions":["claims","feedback"]},{"firstName":"Gilad","lastName":"Feder","orderAmount":"987.6","dateData":1557834321099,"iconData":{"icon":"copy"},"paymentMethod":"MasterCard"},{"firstName":false,"lastName":"Yosef","orderAmount":"12","dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]},{"firstName":"Ori","lastName":"Weingart","orderAmount":"17","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Visa","rowActions":["claims","feedback"]},{"firstName":"Gilad","lastName":"Feder","orderAmount":"987.6","dateData":1557834321099,"iconData":{"icon":"copy"},"paymentMethod":"MasterCard"},{"firstName":false,"lastName":"Yosef","orderAmount":"12","dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]}]>
      <div slot="footer"><fc-button>Export</fc-button></div>
</fc-table>

Examples

<!-- empty -->
<fc-table></fc-table>

<!-- simpleTable -->
<fc-table
      columns=[{"label":"Text_Column","fromKey":"textData","type":"TEXT"},{"label":"Date_Column","fromKey":"dateData","type":"DATE"},{"label":"Icon_Column","fromKey":"iconData","type":"ICON"}]
      rows=[{"textData":"Some_Long_Text_Data","dateData":1557834321063,"iconData":{"icon":"edit"}},{"textData":"more_data","dateData":1557834321099,"iconData":{"icon":"copy"}}]>
</fc-table>

<!-- noRows -->
<fc-table
      columns=[{"label":"Text_Column","fromKey":"textData","type":"TEXT"},{"label":"Date_Column","fromKey":"dateData","type":"DATE"},{"label":"Icon_Column","fromKey":"iconData","type":"ICON"}]>
</fc-table>

<!-- row color -->
<fc-table
      multi
      row-actions
      columns-draggable
      columns-removable
      columns=[{"label":"First Name","fromKey":"firstName","pinned":true,"removable":false,"sortable":true,"sort":"asc","sortLevel":1,"type":"TEXT","filterable":true,"defaultVisibility":false,"defaultIndex":2,"filter":{"operator":"Matches","searchValues":["lala","abcdefghijklmnopqrstuvwxyz"]}},{"label":"Last Name","fromKey":"lastName","type":"TEXT","sort":"desc","sortLevel":2,"sortable":true,"defaultVisibility":true,"filterable":true,"filter":{"values":[{"label":"Yosef","checked":false,"color":"blue"},{"label":"Anati","checked":false,"color":"green"},{"label":"Weingart","checked":false,"color":"purple"},{"label":"Feder","checked":false,"color":"blue"}]}},{"label":"Payment Method","fromKey":"paymentMethod","type":"CUSTOM","renderer":"moneyRenderer","sortable":true,"defaultIndex":4,"visible":true,"filterable":true,"filter":{"values":[{"label":"PayPal","checked":true},{"label":"Amex","checked":false},{"label":"MasterCard","checked":false},{"label":"Visa","checked":true},{"label":"Bank Transfer","checked":true},{"label":"ApplePay","checked":true},{"label":"Google Pay","checked":false},{"label":"Android Pay","checked":false},{"label":"Amazon Pay","checked":false}],"valuesRenderer":"baba"}},{"label":"Text Column","fromKey":"textData","type":"TEXT","defaultIndex":3,"sortable":true,"visible":false,"filterable":true,"defaultVisibility":true},{"label":"Order Amount","fromKey":"orderAmount","type":"TEXT","custom":"moneyRenderer","visible":true,"filterable":true,"defaultVisibility":true,"filter":{"type":"NUMBER","operator":"Greater Than","searchValues":["1"]}},{"label":"Date Column","fromKey":"dateData","type":"DATE","defaultVisibility":false},{"label":"Icon Column","fromKey":"iconData","type":"ICON","visible":true,"defaultIndex":5,"sortable":true,"filterable":true,"defaultVisibility":true}]
      rows=[{"firstName":false,"color":"#cde5f3","selected":true,"lastName":"Yosef","orderAmount":"12","rowActions":["claims","feedback"],"dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"selected":false,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]},{"firstName":"Ori","lastName":"Weingart","orderAmount":"17","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Visa","rowActions":["claims","feedback"]},{"firstName":"Gilad","lastName":"Feder","orderAmount":"987.6","dateData":1557834321099,"iconData":{"icon":"copy"},"paymentMethod":"MasterCard"},{"firstName":false,"lastName":"Yosef","orderAmount":"12","dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]},{"firstName":"Ori","lastName":"Weingart","orderAmount":"17","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Visa","rowActions":["claims","feedback"]},{"firstName":"Gilad","lastName":"Feder","orderAmount":"987.6","dateData":1557834321099,"iconData":{"icon":"copy"},"paymentMethod":"MasterCard"},{"firstName":false,"lastName":"Yosef","orderAmount":"12","dateData":1557834321099,"paymentMethod":"Amex","iconData":{"icon":"copy"}},{"firstName":true,"lastName":"Anati","orderAmount":"132.5","dateData":1557834321063,"iconData":{"icon":"edit"},"paymentMethod":"Paypal","rowActions":["claims","feedback"]}]>
      <div slot="footer"><fc-button>Export</fc-button></div>
</fc-table>

<!-- loading -->
<fc-table loading
columns=[{"label":"Text_Column","fromKey":"textData","type":"TEXT"},{"label":"Date_Column","fromKey":"dateData","type":"DATE"},{"label":"Icon_Column","fromKey":"iconData","type":"ICON"}]
      rows=[{"textData":"Some_Long_Text_Data","dateData":1557834321063,"iconData":{"icon":"edit"}},{"textData":"more_data","dateData":1557834321099,"iconData":{"icon":"copy"}}]>
</fc-table>

<!-- rowSingleSelect -->
<fc-table select
columns=[{"label":"Text_Column","fromKey":"textData","type":"TEXT"},{"label":"Date_Column","fromKey":"dateData","type":"DATE"},{"label":"Icon_Column","fromKey":"iconData","type":"ICON"}]
      rows=[{"textData":"Some_Long_Text_Data","dateData":1557834321063,"iconData":{"icon":"edit"}},{"textData":"more_data","dateData":1557834321099,"iconData":{"icon":"copy"}}]>
</fc-table>

  * <!-- rowMultiSelect -->
<fc-table
    select
    multi
   columns=[{"label":"Text_Column","fromKey":"textData","type":"TEXT"},{"label":"Date_Column","fromKey":"dateData","type":"DATE"},{"label":"Icon_Column","fromKey":"iconData","type":"ICON"}]
      rows=[{"textData":"Some_Long_Text_Data","dateData":1557834321063,"iconData":{"icon":"edit"}},{"textData":"more_data","dateData":1557834321099,"iconData":{"icon":"copy"}}]>
</fc-table>

Properties

PropertyAttributeTypeDefaultDescription
checkedany[]
columnscolumnsany[]Column descriptors. example: [{ "label": "Text Column", "fromKey": "textData", "type": "TEXT" }, { "label": "Date Column", "fromKey": "dateData", "type": "DATE" },{ "label": "Icon Column", "fromKey": "iconData", "type": "ICON" }]
columnsDraggablecolumns-draggablebooleanWhether or not dragging columns is enabled
columnsRemovablecolumns-removable"" \| TemplateResult
compactCellscompact-cellsbooleanfalseWhether or not to make the cells of the table compact (with white space wrapping). example: true
displayNoData({ loading, rows }: { loading: any; rows: any; }) => TemplateResult
editableeditablebooleanfalseWhether or not to show create button for editing. example: true
editingeditingbooleanfalseWhether or not grid support editing of a selected row. example: true
fetchingfetchingbooleanWhether the table is fetching new data
filterable"" \| TemplateResult
filtersnever[]
hideColumnOptionshide-column-optionsbooleanfalseWhether or not to display the column options button. example: true
hideColumnSaveButtonshide-column-save-buttonsbooleanfalseWhether or not to display the column save buttons. example: true
hideFooterhide-footerbooleanfalseWhether or not to show the footer. example: true
loadingloading"" \| TemplateResult
multimultibooleanWhether selecting multiple rows is enabled.
noRowsstring
preventSecondarySortprevent-secondary-sortbooleanfalseWhether or not multiple column sort is enabled. example: true
removableremovablebooleanfalseWhether or not to show delete button. example: true
renderNoDataPlaceHolder({ loading, rows, totalColumnsNum }: { loading: any; rows: any; totalColumnsNum: any; }) => TemplateResult
renderersrenderersanyCustom renderer class. Used in custom columns
resultTemplateResult \| null
rowActionsrow-actionsbooleanWhether or not the row actions button is enabled
rowLimitrow-limitnumber10Whether or not to show create button for editing. example: 10
rowsrowsany[]Row Descriptors. example: [{"textData": "Some Long Text Data","dateData": 1557834321063,"iconData": { "icon": "3dots" }}];
selectselectbooleanWhether selecting rows is enabled.
translatetranslatebooleanWhether to translate cells
wrapwrapbooleanfalseIf table should fit in it's area or should have a scrollbar
zebrazebrabooleanWhether or not the row table has a striped pattern on the rows

Events

EventDescription
column-change{ actionType: String }
reset-column
row-action{ rowIndex: Number, actionName: String }
row-selected{ selected: Row }
sort-table{ column: Number, direction: 'asc'\|'desc' }
table-action{ columnIndex: Number, rowIndex: Number, index: Number }
table-row-click

CSS Custom Properties

PropertyDescription
--fc-table-backgrounddefault: white
--fc-table-cell-paddingdefault: 15px 25px
--fc-table-header-cell-paddingdefault: 10px 25px
--fc-table-min-col-widthdefault: 100px
--fc-table-paddingdefault: 0
--fc-table-zebra-colordefault: #f8f9fa
3.2.3

26 days ago

3.2.2

26 days ago

3.2.1

2 months ago

3.2.0

2 months ago

3.1.0

2 months ago

3.0.46

3 months ago

3.0.45

4 months ago

3.0.44

4 months ago

3.0.43

9 months ago

3.0.41

10 months ago

3.0.42

10 months ago

3.0.40

10 months ago

3.0.39

11 months ago

3.0.34

12 months ago

3.0.35

12 months ago

3.0.33

1 year ago

3.0.38

11 months ago

3.0.36

12 months ago

3.0.37

11 months ago

3.0.23

1 year ago

3.0.24

1 year ago

3.0.21

1 year ago

3.0.22

1 year ago

3.0.27

1 year ago

3.0.28

1 year ago

3.0.25

1 year ago

3.0.26

1 year ago

3.0.20

1 year ago

3.0.18

1 year ago

3.0.19

1 year ago

3.0.32

1 year ago

3.0.30

1 year ago

3.0.31

1 year ago

3.0.29

1 year ago

3.0.16

1 year ago

3.0.17

1 year ago

3.0.14

1 year ago

3.0.15

1 year ago

3.0.12

1 year ago

3.0.13

1 year ago

3.0.11

1 year ago

3.0.4

1 year ago

3.0.8

1 year ago

3.0.7

1 year ago

3.0.6

1 year ago

3.0.5

1 year ago

3.0.9

1 year ago

3.0.10

1 year ago

3.0.3

1 year ago

3.0.2

1 year ago

3.0.1

1 year ago

3.0.0

1 year ago

2.35.8

1 year ago

2.35.5

2 years ago

2.35.4

2 years ago

2.35.7

1 year ago

2.35.6

1 year ago

2.35.1

2 years ago

2.35.3

2 years ago

2.35.2

2 years ago

2.35.0

2 years ago

2.34.12

2 years ago

2.34.13

2 years ago

2.34.11

2 years ago

2.34.14

2 years ago

2.34.0

2 years ago

2.34.9

2 years ago

2.34.6

2 years ago

2.34.5

2 years ago

2.34.8

2 years ago

2.34.7

2 years ago

2.34.2

2 years ago

2.34.1

2 years ago

2.34.4

2 years ago

2.34.3

2 years ago

2.34.10

2 years ago

2.33.30

2 years ago

2.33.26

2 years ago

2.33.27

2 years ago

2.33.25

2 years ago

2.33.22

2 years ago

2.33.23

2 years ago

2.33.24

2 years ago

2.33.15

2 years ago

2.33.16

2 years ago

2.33.14

2 years ago

2.33.19

2 years ago

2.33.17

2 years ago

2.33.18

2 years ago

2.33.20

2 years ago

2.33.21

2 years ago

2.33.13

2 years ago

2.33.11

2 years ago

2.33.12

2 years ago

2.33.10

2 years ago

2.33.7

3 years ago

2.33.9

2 years ago

2.33.8

2 years ago

2.33.6

3 years ago

2.33.5

3 years ago

2.33.3

3 years ago

2.33.4

3 years ago

2.33.2

3 years ago

2.33.1

3 years ago

2.33.0

3 years ago

2.32.13

3 years ago

2.32.12

3 years ago

2.32.11

3 years ago

2.32.10

3 years ago

2.32.8

3 years ago

2.32.7

3 years ago

2.32.9

3 years ago

2.32.6

3 years ago

2.32.5

3 years ago

2.32.4

3 years ago

2.32.3

3 years ago

2.32.2

3 years ago

2.32.1

3 years ago

2.32.0

3 years ago

2.31.5

3 years ago

2.31.3

3 years ago

2.31.2

3 years ago

2.31.4

3 years ago

2.31.1

3 years ago

2.30.4

3 years ago

2.31.0

3 years ago

2.30.2

3 years ago

2.30.3

3 years ago

2.30.1

3 years ago

2.30.0

3 years ago

2.29.7

3 years ago

2.29.6

3 years ago

2.29.5

3 years ago

2.29.4

3 years ago

2.29.3

3 years ago

2.29.2

3 years ago

2.29.0

3 years ago

2.29.1

3 years ago

2.27.0

3 years ago

2.26.1

3 years ago

2.26.0

3 years ago

2.28.0

3 years ago

2.25.1

3 years ago

2.25.0

3 years ago

2.24.12

3 years ago

2.24.11

3 years ago

2.24.10

3 years ago

2.24.9

3 years ago

2.24.8

3 years ago

2.24.7

3 years ago

2.24.6

3 years ago

2.24.5

3 years ago

2.24.4

3 years ago

2.24.3

3 years ago

2.24.1

3 years ago

2.24.2

3 years ago

2.24.0

3 years ago

2.23.1

3 years ago

2.22.0

3 years ago

2.21.4

3 years ago

2.23.0

3 years ago

2.21.3

3 years ago

2.21.2

3 years ago

2.21.1

3 years ago

2.21.0

3 years ago

2.20.0

3 years ago

2.19.2

3 years ago

2.19.0

3 years ago

2.19.1

3 years ago

2.18.0

3 years ago

2.17.0

3 years ago

2.16.2

3 years ago

2.16.1

3 years ago

2.15.1

3 years ago

2.16.0

3 years ago

2.15.0

3 years ago

2.14.0

3 years ago

2.13.1

3 years ago

2.13.0

3 years ago

2.12.0

3 years ago

2.11.0

3 years ago

2.10.3

3 years ago

2.10.2

3 years ago

2.10.1

3 years ago

2.10.0

3 years ago

2.9.1

3 years ago

2.9.0

3 years ago

2.8.0

3 years ago

2.7.4

3 years ago

2.7.3

3 years ago

2.7.2

3 years ago

2.7.1

3 years ago

2.6.1

3 years ago

2.7.0

3 years ago

2.6.0

3 years ago

2.5.1

3 years ago

2.5.0

3 years ago

2.4.1

4 years ago

2.4.0

4 years ago

2.3.7

4 years ago

2.3.6

4 years ago

2.3.5

4 years ago

2.3.4

4 years ago

2.3.3

4 years ago

2.3.2

4 years ago

2.3.1

4 years ago

2.3.0

4 years ago

2.2.17

4 years ago

2.2.15

4 years ago

2.2.16

4 years ago

2.2.14

4 years ago

2.2.13

4 years ago

2.2.12

4 years ago

2.2.11

4 years ago

2.2.10

4 years ago

2.2.9

4 years ago

2.2.8

4 years ago

2.2.7

4 years ago

2.2.6

4 years ago

2.2.5

4 years ago

2.2.4

4 years ago

2.2.3

4 years ago

2.2.2

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.41

4 years ago

2.1.40

4 years ago

2.1.39

4 years ago

2.1.38

4 years ago

2.1.37

4 years ago

2.1.36

4 years ago

2.1.35

4 years ago

2.1.34

4 years ago

2.1.33

4 years ago

2.1.32

4 years ago

2.1.31

4 years ago

2.1.30

4 years ago

2.1.29

4 years ago

2.1.28

4 years ago

2.1.27

4 years ago

2.1.26

4 years ago

2.1.25

4 years ago

2.1.24

4 years ago

2.1.23

4 years ago

2.1.21

4 years ago

2.1.22

4 years ago

2.1.20

4 years ago

2.1.19

4 years ago

2.1.18

4 years ago

2.1.17

4 years ago

2.1.16

4 years ago

2.1.15

4 years ago

2.1.14

4 years ago

2.1.13

4 years ago

2.1.12

4 years ago

2.1.11

4 years ago

2.1.10

4 years ago

2.1.8

4 years ago

2.1.9

4 years ago

2.1.7

4 years ago

2.1.6

5 years ago

2.1.5

5 years ago

2.1.4

5 years ago

2.1.3

5 years ago

2.1.2

5 years ago

2.1.1

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.1.5

5 years ago

1.1.4

5 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.1-beta.336

5 years ago

1.0.1-beta.334

5 years ago

1.0.1-beta.333

5 years ago

1.0.1-beta.329

5 years ago

1.0.1-beta.328

5 years ago

1.0.1-beta.327

5 years ago