Sidebar
Import
import { Sidebar } from '@resultadosdigitais/tangram-components'
Properties
children
disableAutoPositioning
| Type | bool |
|---|---|
| Default | false |
Description
Disables automatic positioning of the component.
If this property is true, the component positioning must be provided by some external means.
collapsible
close
defaultClose
closeLabelText
| Type | string |
|---|---|
| Default | Sidebar.translations.en.close |
Description
Custom text for the label that identifies the close icon
for the collapsible Sidebar. This text is not displayed on the screen.
Preset values for English, Brazilian Portuguese and Spanish are available
in Sidebar.translations.en.close,
Sidebar.translations.ptBR.close and
Sidebar.translations.es.close.
openLabelText
| Type | string |
|---|---|
| Default | Sidebar.translations.en.open |
Description
Custom text for the label that identifies the open icon
for the collapsible Sidebar. This text is not displayed on the screen.
Preset values for English, Brazilian Portuguese and Spanish are available
in Sidebar.translations.en.open,
Sidebar.translations.ptBR.open and
Sidebar.translations.es.open.
onChange
| Type | func |
|---|---|
| Param | event React.SyntheticEvent - The event source of the callback. |
| Param | isClose boolean - Boolean value indicating whether the Sidebar is closed. |
Description
Callback fired when the collapsible Sidebar
changes from open to closed or closed to open.
positionRelativeTo
| Type | string | shape | instanceOf |
|---|---|
| Default | null |
Description
Element (or reference to an element) that the Sidebar should be positioned relative to.
Accepts:
- a
string(element id) - a ref object (
{ current: Element }) - an
Element
When provided, the Sidebar will be positioned fixed relative to this element,
positioned to the left and top of the referenced element.
<SidebarFooter />
Import
import { SidebarFooter } from '@resultadosdigitais/tangram-components'
Properties
children
<SidebarHeader />
Import
import { SidebarHeader } from '@resultadosdigitais/tangram-components'
Properties
children
<SidebarLabel />
Import
import { SidebarLabel } from '@resultadosdigitais/tangram-components'
Properties
children
Feedback
To report a problem or suggest changes, use our improvements form or, if you prefer, open an issue on our Github repository.