Skip to content

[EuiFlyout] Improve documentation #8774

Open
Open
@tkajtoch

Description

@tkajtoch

Summary

As part of the global flyouts work, we want to improve the documentation of EuiFlyout and related components.

Acceptance criteria

  • EuiFlyoutResizable docs should be moved to a separate page and linked from the main EuiFlyout docs page
  • Content should be updated to put less focus on prop examples (various sections demonstrating each prop in isolation) and instead provide good prop descriptions in the prop table
  • A new section should be added on top of the main EuiFlyout page stating that there are two types of flyouts - regular and resizable (so that when the third type, the child flyout, is ready we can add it there as well)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssues or PRs that only affect documentation - will not need changelog entries

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions