Skip to content

docs: Add stackingOrder prop to docs #536

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.

Sign up for GitHub

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

Open
MatiPl01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add stackingOrder prop to docs #536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions packages/docs/docs/flex/props.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,23 @@ Controls if the overflowing content should be clipped or visible. Applies only w

---

### stackingOrder

Strategy for setting zIndex of items. This determines which items appear on top when they overlap.

| type | default | required |
| ----------------- | ------- | -------- |
| `'asc' \| 'desc'` | `'asc'` | NO |

- `'asc'` - items with higher index have higher zIndex (default). This means items at the end of the list of items are rendered on top of items at the beginning.
- `'desc'` - items with higher index have lower zIndex. This means items at the beginning of the list of items are rendered on top of items at the end.

:::info
The currently dragged item is always rendered on top of all other items, regardless of this setting.
:::

---

### debug

Enables debug mode, which shows additional views helpful for debugging. This property is intended for the library **developers** and is not recommended for the library **users**.
Expand Down
24 changes: 22 additions & 2 deletions packages/docs/docs/grid/props.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -797,9 +797,29 @@ You can also use any other haptics library but you will have to trigger haptics

Controls if the overflowing content should be clipped or visible. Applies only when no item is active.

| type | default | required |
| type | default | required |
| ----------------------- | ----------- | -------- |
| `'hidden' \| 'visible'` | `'visible'` | NO |

---

### stackingOrder

Strategy for setting zIndex of items. This determines which items appear on top when they overlap.

| type | default | required |
| ----------------- | ------- | -------- |
| `'asc' \| 'desc'` | `'asc'` | NO |

- `'asc'` - items with higher index have higher zIndex (default). This means items at the end of the list of items are rendered on top of items at the beginning.
- `'desc'` - items with higher index have lower zIndex. This means items at the beginning of the list of items are rendered on top of items at the end.

:::info
The currently dragged item is always rendered on top of all other items, regardless of this setting.
:::

| ----------------------- | ---------- | -------- |
| `'hidden' \| 'visible'` | `'hidden'` | NO |
| `'hidden' \| 'visible'` | `'hidden'` | NO |

---

Expand Down
Loading