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.

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

Jump to bottom

chore: update docs #105

Merged
merged 1 commit into from
Mar 13, 2024
Merged

chore: update docs #105

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
4 changes: 4 additions & 0 deletions documentation/docs/api/Components/LinkWithStatePassthrough.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ sidebar_position: 3
import { LinkWithStatePassthrough } from '@orfium/toolbox';
```

:::info
Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
:::

## Description

A utility component that wraps over React Router's [`Link`](https://v5.reactrouter.com/web/api/Link) component,
Expand Down
5 changes: 5 additions & 0 deletions documentation/docs/api/Components/NavLinkWithStatePassthrough.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ sidebar_position: 3
import { NavLinkWithStatePassthrough } from '@orfium/toolbox';
```

:::info
Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
:::


## Description

A utility component that wraps over React Router's [`NavLink`](https://v5.reactrouter.com/web/api/NavLink) component,
Expand Down
6 changes: 5 additions & 1 deletion documentation/docs/api/Components/Navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import Type from '../_type-definitions/NavigationProps.md';
import { Navigation } from '@orfium/toolbox';
```

:::info
Must be a descendant of [`Toolbox`](./Toolbox), [`ThemeProvider`](https://designlab.orfium.com/?path=/docs/design-system-themeprovider--setting-up-a-button-example) and [`Router`](https://v5.reactrouter.com/web/api/Router).
:::

## Description

A UI component that handles user navigation both within the current product and among Orfium products. It is comprised of
Expand Down Expand Up @@ -47,7 +51,7 @@ navigation links within `Navigation` pass that history state around to one anoth
URL path as its `href` value.
:::

:::caution
:::warning
If your admin views have navigation of their own (by means of redirects or links), using regular
[`Link`](https://v5.reactrouter.com/web/api/Link)s, [`NavLink`](https://v5.reactrouter.com/web/api/NavLink)s or
[`Redirect`](https://v5.reactrouter.com/web/api/Redirect)s without passing around the history state will "break" the
Expand Down
4 changes: 4 additions & 0 deletions documentation/docs/api/Components/RedirectWithStatePassthrough.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ sidebar_position: 3
import { RedirectWithStatePassthrough } from '@orfium/toolbox';
```

:::info
Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
:::

## Description

A utility component that wraps over React Router's [`Redirect`](https://v5.reactrouter.com/web/api/Redirect) component,
Expand Down
5 changes: 5 additions & 0 deletions documentation/docs/api/Components/TopBar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ import Type from '../_type-definitions/TopBarProps.md';
import { TopBar } from '@orfium/toolbox';
```

:::info
Must be a descendant of [`Toolbox`](./Toolbox), [`ThemeProvider`](https://designlab.orfium.com/?path=/docs/design-system-themeprovider--setting-up-a-button-example) and [`Router`](https://v5.reactrouter.com/web/api/Router).
:::


## Description

A UI component that holds other UI elements such as the user menu on the right and an optional utility section on the
Expand Down
Loading