BulkActions
Import
import { BulkActions } from '@resultadosdigitais/tangram-components'
Properties
children
onClear
| Type | func |
|---|---|
| Param | event React.SyntheticEvent - The event source of the callback. |
Description
Callback fired when the clear button is clicked.
onSelectAll
| Type | func |
|---|---|
| Param | event React.SyntheticEvent - The event source of the callback. |
| Param | checked boolean - The value of event.target.checked |
Description
Callback fired when the select all option is checked.
showSelectAll
selectAll
totalSelected
total
clearLabel
| Type | string | func |
|---|---|
| Default | BulkActions.translations.en.clear |
| Param | args object - Object with information available for rendering the information in case the attribute value is a function. |
Description
Custom text for the clear button.
Preset values for English, Brazilian Portuguese and Spanish are available
in BulkActions.translations.en.clear,
BulkActions.translations.ptBR.clear and
BulkActions.translations.es.clear.
// Can be a string:
clearLabel="Clear selection of {totalSelected} items"
// Or a function (that returns a string):
clearLabel={({ total, totalSelected }) => `Clear selection of ${totalSelected} items`}
totalSelectedLabel
| Type | string | func |
|---|---|
| Default | BulkActions.translations.en.totalSelected |
| Param | args object - Object with information available for rendering the information in case the attribute value is a function. |
Description
Custom text for the total selected items.
Preset values for English, Brazilian Portuguese and Spanish are available
in BulkActions.translations.en.totalSelected,
BulkActions.translations.ptBR.totalSelected and
BulkActions.translations.es.totalSelected.
// Can be a string:
totalSelectedLabel="{totalSelected} items"
// Or a function (that returns a string):
totalSelectedLabel={({ total, totalSelected }) => `${totalSelected} items`}
selectAllLabel
| Type | string | func |
|---|---|
| Default | BulkActions.translations.en.selectAll |
| Param | args object - Object with information available for rendering the information in case the attribute value is a function. |
Description
Custom text for the select all button.
Preset values for English, Brazilian Portuguese and Spanish are available
in BulkActions.translations.en.selectAll,
BulkActions.translations.ptBR.selectAll and
BulkActions.translations.es.selectAll.
// Can be a string:
selectAllLabel="Select all {total} items"
// Or a function (that returns a string):
selectAllLabel={({ total, totalSelected }) => `Select all ${total} items`}