Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Skeleton component documentation #862

Merged
merged 3 commits into from
Aug 23, 2024

Conversation

elviskahoro
Copy link
Contributor

This pull request adds documentation for the Skeleton component in the library. The new file, skeleton.md, provides an overview of the Skeleton component, which serves as a loading placeholder for content that is not yet available.

The documentation includes:

  1. A brief description of the Skeleton component and its purpose.
  2. A demo showcasing different uses of the Skeleton component, including:
    • Skeleton placeholders for buttons of different sizes
    • Skeleton placeholders for text elements with loading states
  3. Usage tips for implementing Skeleton with text elements.
  4. Information on using the loading prop to control the visibility of the skeleton or its children.

This addition will help users understand and implement the Skeleton component in their Reflex applications, improving the user experience during content loading.

Copy link

linear bot commented Aug 23, 2024

Copy link
Contributor Author

elviskahoro commented Aug 23, 2024

Copy link
Collaborator

@Lendemor Lendemor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a typo I think.

the rest seems fine 👍

docs/library/other/skeleton.md Outdated Show resolved Hide resolved
@elviskahoro elviskahoro requested a review from Lendemor August 23, 2024 19:52
@elviskahoro elviskahoro force-pushed the elvis/ref-3558-document-radix-component-skeleton branch 2 times, most recently from 9c30f5e to 9495749 Compare August 23, 2024 20:07
Copy link
Contributor Author

elviskahoro commented Aug 23, 2024

Merge activity

  • Aug 23, 4:25 PM EDT: @elviskahoro started a stack merge that includes this pull request via Graphite.
  • Aug 23, 4:27 PM EDT: Graphite rebased this pull request as part of a merge.
  • Aug 23, 4:35 PM EDT: @elviskahoro merged this pull request with Graphite.

@elviskahoro elviskahoro changed the base branch from elvis/lint-pcweb-pages-docs-library to graphite-base/862 August 23, 2024 20:25
@elviskahoro elviskahoro changed the base branch from graphite-base/862 to main August 23, 2024 20:25
@elviskahoro elviskahoro force-pushed the elvis/ref-3558-document-radix-component-skeleton branch from 9495749 to 7d0dcaf Compare August 23, 2024 20:26
@elviskahoro elviskahoro merged commit c299dc6 into main Aug 23, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants