-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Adding docs for Skeleton from Radix
- Loading branch information
1 parent
6540fad
commit ed4633b
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
description: Skeleton, a loading placeholder component for content that is not yet available. | ||
components: | ||
- rx.skeleton | ||
--- | ||
|
||
```python exec | ||
import reflex as rx | ||
``` | ||
|
||
# Skeleton (loading placeholder) | ||
|
||
`Skeleton` is a loading placeholder component that serves as a visual placeholder while content is loading. | ||
It is useful for maintaining the layout's structure and providing users with a sense of progression while awaiting the final content. | ||
|
||
```python demo | ||
rx.vstack( | ||
rx.skeleton(rx.button("button-small"), height="10px"), | ||
rx.skeleton(rx.button("button-big"), height="20px"), | ||
rx.skeleton(rx.text("Text is loaded."), loading=True,), | ||
rx.skeleton(rx.text("Text is already loaded."), loading=False,), | ||
), | ||
``` | ||
|
||
When using `Skeleton` with text, wrap the text itself instead of the element instead of the parent element to have a placeholder of the same size. | ||
|
||
Use the loading prop to control whether the skeleton or its children are displayed. Skeleton preserves the dimensions of children when they are hidden and disables interactive elements. |