react.md
February 22, 2023 ยท View on GitHub
react package
Enumerations
| Enumeration | Description |
|---|---|
| DisplayOrder | The vertical display ordering for workflow steps. |
| StatsColumnType | Available column statistics to show in the Arquero Details List |
Functions
| Function | Description |
|---|---|
| useDefaultCodebookStyles(heights) | Generates the default codebook styles |
| useHeaderCommandBarDefaults(props, far, colors) | Helper to create the props necessary for the default inverted management bar. Basic colors can be customized, but note that if you do not want an always-inverted bar like that used in the DataShaper webapp, you may want to just tweak the Fluent styles as normal. |
Interfaces
| Interface | Description |
|---|---|
| ArqueroDetailsListFeatures | Feature flags and configuration for the Arquero Details List component |
| ArqueroDetailsListProps | Props for the Arquero Details List component |
| ArqueroTableHeaderProps | Props for the ArqueroTableHeader component |
| ArqueroTableHeaderStyles | |
| CodebookProps | Props for the CodebookEditor component |
| CodebookTableStyles | |
| CommandBarColors | |
| FieldWellItem | Defines an available field well. This includes UX properties for how to visually represent it (title, icon, etc). This implementation is rendered with a dropdown, and is in many ways just a fancy stylized dropdown. |
| FieldWellProps | Props for the FieldWell component. |
| FieldWellStyles | |
| StepListProps | |
| StepListStyles | |
| TableCommandsProps |
Variables
| Variable | Description |
|---|---|
| ArqueroDetailsList | Renders an arquero table using a fluent DetailsList. |
| ArqueroTableHeader | Renders a header for an Arquero table |
| Codebook | |
| FieldWell | |
| StepList | |
| TableCommands |
Type Aliases
| Type Alias | Description |
|---|---|
| ColumnRenderFunction | |
| ColumnSelectFunction | |
| DropdownOptionSelect | |
| GroupHeaderFunction | |
| SaveMetadataFunction |