Commit 19f36ae
Document cascade component implementation (elastic#226927)
## Summary
Culled from elastic#220119, Closes
elastic/kibana-team#1791
This PR extracts the generic data cascade component implementation into
a standalone PR, This component allows displaying a large set of grouped
data without loading the entire data set at once, only the starting
point for the data is required, then the rest of the data is loaded on
demand by the user, this component also employs virtualisations
techniques so that regardless of the number of data being browsed by the
user only the data the user is viewing is being rendered.
Furthermore as much as this component is in a way a skeleton, it is
opinionated about how data is fetched and because of this, the loading
state and the UI element rendered during these states are also
opinionated.
This component exposes parts that are composed into the data cascade
experience, like so;
```tsx
<DataCascade {...dataCascadeProps}>
<DataCascadeRow {...dataCascadeRowProps}>
<DataCascadeRowCell {...dataCascadeRowCellProps}>
{({ data }) => {
// your cell component
}}
</DataCascadeRowCell>
</DataCascadeRow>
</DataCascade>
```
### Testing
- Spin up the shared ux storybook like so; `yarn storybook shared_ux`,
then look for the data cascade component
- Alternatively, you could use this
[link](https://ci-artifacts.kibana.dev/storybooks/pr-226927/shared_ux/index.html?path=/docs/data-cascade-configuration-examples--docs)
### Visuals
https://github.com/user-attachments/assets/d04cd77d-46df-425e-a3f3-e85798e6f0eb
## Accessibility
- The defined spec for [tree grids
](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) informed the
existing approach to ensure that the same visual experience presented to
users is translated to the accessibility tree generated. This work
doesn't purport to fulfil all the expectations of a standard treegrid
experience.
## Note for reviewer
This PR is the preliminary PR for the data cascade component, to help
land the cascade experience in discover, whilst there's a laundry list
of functionality that the cascade component should support, already
supports them for the most part, the goal of this PR is to land the
component in Kibana with the base case for the cascade experience
working.
## Note on new packages
The `@tanstack/react-virtual` & `@tanstack/table` packages have been
added to provide base functionality to manage virtualisation and data
structuring respectively in the cascade component, whilst there already
exist another package (react-window) that does virtualization in Kibana,
it doesn't quite provide the same flexibility that
`@tanstack/react-virtual` provides and has a much larger footprint, for
this reason it was selected, and for what it's worth there's an ongoing
exploration for deciding on the package we should default to for
virtualization in Kibana, [see
here](elastic#224197).
<!--
### Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [ ] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.
### Identify risks
Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.
Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.
- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...
-->
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Ryan Keairns <contactryank@gmail.com>1 parent c2ab8cc commit 19f36ae
63 files changed
Lines changed: 6346 additions & 3 deletions
File tree
- .buildkite/scripts/steps/security
- .github
- src/platform/packages
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 3 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
663 | 663 | | |
664 | 664 | | |
665 | 665 | | |
| 666 | + | |
666 | 667 | | |
667 | 668 | | |
668 | 669 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
989 | 989 | | |
990 | 990 | | |
991 | 991 | | |
| 992 | + | |
992 | 993 | | |
993 | 994 | | |
994 | 995 | | |
| |||
1192 | 1193 | | |
1193 | 1194 | | |
1194 | 1195 | | |
| 1196 | + | |
| 1197 | + | |
1195 | 1198 | | |
1196 | 1199 | | |
1197 | 1200 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
723 | 723 | | |
724 | 724 | | |
725 | 725 | | |
| 726 | + | |
| 727 | + | |
| 728 | + | |
| 729 | + | |
| 730 | + | |
| 731 | + | |
| 732 | + | |
| 733 | + | |
726 | 734 | | |
727 | 735 | | |
728 | 736 | | |
| |||
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
17 | 18 | | |
18 | 19 | | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
19 | 23 | | |
Lines changed: 26 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
Lines changed: 20 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
Lines changed: 14 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
0 commit comments