Progressive Grid
Progressive Grid lets users navigate through sets of related data, stacked vertically.
Usage Guidance
Coming soon!
API Guidelines
Note: these API guidelines only apply to the view grid
Methods
Class name: ProgressiveGrid Module name: UIComponentsPlugin
public init(
featureData: FeatureMetricsData,
context: SemanticContext = .default,
showSheet: Binding<Bool>,
gridTitle: String,
gridSubtitle: String? = nil,
rows: [Row],
columnGroups: [ColumnGroup],
localizer: LocalizationAdapting
)Parameters
| Name | Description | Default values |
|---|---|---|
| featureData | the feature name/context and the screen ID in which the component appears. | |
| context | the SemanticContext. | SemanticContext.default |
| showSheet | Binding bool used to decide when the grid sheet needs to be displayed. | |
| gridTitle | the title of the whole grid, already localized. | |
| gridSubtitle | the subtitle of the whole grid, already localized. | nil |
| rows | a list of row data with the data already localized. | |
| columnGroups | column titles of the grid, already localized. Can be grouped with titles, not required. | |
| localizer | Localizer used for localizing strings in the view. |
Prerequisite: The length of the row data and the number of columns (outside of groups) must be equal.
Accessibility Guidelines
Coming soon!
Usage Guidance
Coming soon!
API Guidelines
Note: these API guidelines only apply to the view grid
Methods
fun ProgressiveViewGridUiComponent(
modifier: Modifier = Modifier,
gridTitle: String,
gridSubtitle: String? = null,
rows: List<ProgressiveViewGridRow>,
columnGroups: List<ColumnGroup>,
)Parameters
| Name | Description | Default values |
|---|---|---|
| modifier | The modifier to be applied to the component. | Modifier |
| gridTitle | Title of the grid that will be displayed above the rows of the progressive grid. | |
| gridSubtitle | Optional subtitle that will be displayed below the title. | null |
| rows | List of [ProgressiveViewGridRow] models. The number of columns in each row needs to match the number of column titles in [columnGroups]. | |
| columnGroups | List of [ColumnGroup] models used to provide the titles for each column and optionally group them. |
Note: Put all column titles in one group without a groupTitle in the case of no grouped columns
Accessibility Guidelines
Coming soon!
Can't Find What You Need?
Check out our FAQ section which may help you find the information you're looking for. For further information, contact the #ask-canvas-design or #ask-canvas-kitchannels on Slack.