fix(website): add missing props tables

[weronikaolejniczak]

Summary

I added missing props tables to EUI+ pages. Check the issue for the whole list: #139

If you notice any more let me know, I can add them as part of this PR.

QA

Use the staging link from the comment below. Cross-reference with the list in the issue ☝🏻

[mgadewoll]

EuiTreeViewItem is basically an internal subcomponent. The TreeView API doesn't expect it to be usable by consumers.
Instead we should provide types for the required items prop (same as here) which uses EuiTreeViewNodes. (ref) EuiTreeViewNode does not directly translate to EuiTreeViewItem.

I do notice that those additional types are not provided by the generated docgen though 👀
@tkajtoch Is there a way to add those?

[weronikaolejniczak]

@mgadewoll I understand, thanks! I see that EuiTreeView is a compound component:

eui/packages/eui/src/components/tree_view/tree_view.tsx

Lines 370 to 373 in b937ece

	export const EuiTreeView = Object.assign(
	withEuiTheme<EuiTreeViewProps>(EuiTreeViewClass),
	{ Item: EuiTreeViewItem }
	);

and there is one usage of EuiTreeView.Item in Kibana: x-pack/plugins/kubernetes_security/public/components/tree_view_container/dynamic_tree_view/index.tsx

If this is not generally allowed, it would be good to add a deprecation note / create a task in Kibana to refactor and remove the subcomponent Item.

[mgadewoll]

Yeah it's a compound but the EuiTreeView component doesn't expect it to be used with it (besides the internal usage). But I don't think it's disallowed per se as it's exported and with that it could be used standalone - which apparently it is 😅 (good thinking on checking Kibana)

I guess we can keep the props table for it for now in that case 👍

[weronikaolejniczak]

@mgadewoll what would you say about EuiBreadcrumb? 🤔 It's also an internal component but not compound and not exported.

Investigating a way to showcase types like EuiTreeViewNode might still be necessary, probably not on this PR though (?). We can move the discussion to Slack.

[mgadewoll]

If it's not exported, I'd opt to not show it as it might only cause confusion on the usage if we show something that's not needed for consumers. 👍

Investigating a way to showcase types like EuiTreeViewNode might still be necessary, probably not on this PR though (?)

Yes, I'd not want to block this PR because of it, as it's not clear yet if it's even possible with the available docgen generator. Let's investigate this separately.

[weronikaolejniczak]

@mgadewoll I updated the prop tables to NOT show internal components (unless they can also be used standalone). I created an issue for the investigation #141 and added the list of missing types from this PR. Could you take a look?

[mgadewoll]

Looks good to me, thanks for the update! 👍

[mgadewoll]

🚢 🐈‍⬛ Thanks for adding the missing props tables!

[kibanamachine]

Preview staging links for this PR:

• Docs site: https://eui.elastic.co/pr_8126/
• Storybook: https://eui.elastic.co/pr_8126/storybook
• New docs: https://eui.elastic.co/pr_8126/new-docs

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: f194f0f

History

• 💚 Build #3033 succeeded 535fff7