Skip to content

Commit a75e9db

Browse files
author
Documentation Bot
committed
Automated: Update documentation and clean temp folder
1 parent 4601da0 commit a75e9db

File tree

45 files changed

+790
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+790
-0
lines changed

docs/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md)
4+
5+
## API Reference
6+
7+
## Packages
8+
9+
| Package | Description |
10+
| --- | --- |
11+
| [react-directus](./react-directus.md) | |
12+

docs/react-directus.authstates.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [AuthStates](./react-directus.authstates.md)
4+
5+
## AuthStates type
6+
7+
Possible states of the authentication.
8+
9+
**Signature:**
10+
11+
```typescript
12+
export type AuthStates = 'loading' | 'authenticated' | 'unauthenticated';
13+
```
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAsset](./react-directus.directusasset.md)
4+
5+
## DirectusAsset variable
6+
7+
DirectusAsset is a React Component that renders an asset from your Directus API.
8+
9+
**Signature:**
10+
11+
```typescript
12+
DirectusAsset: ({ apiUrl: propsApiUrl, accessToken: propsAccessToken, asset, download, render, }: DirectusAssetProps) => JSX.Element
13+
```
14+
15+
## Example
16+
17+
Here is an example of how to use DirectusAsset
18+
19+
```tsx
20+
import { DirectusAsset } from 'react-directus';
21+
import { createRoot } from 'react-dom/client';
22+
23+
const root = createRoot(document.getElementById('root'));
24+
root.render(
25+
<DirectusAsset asset={1} render={({ url }) => <img src={url} />} />
26+
);
27+
```
28+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md) &gt; [accessToken](./react-directus.directusassetprops.accesstoken.md)
4+
5+
## DirectusAssetProps.accessToken property
6+
7+
The current user's access token.
8+
9+
**Signature:**
10+
11+
```typescript
12+
accessToken?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md) &gt; [apiUrl](./react-directus.directusassetprops.apiurl.md)
4+
5+
## DirectusAssetProps.apiUrl property
6+
7+
url to your Directus instance.
8+
9+
**Signature:**
10+
11+
```typescript
12+
apiUrl?: string;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md) &gt; [asset](./react-directus.directusassetprops.asset.md)
4+
5+
## DirectusAssetProps.asset property
6+
7+
The asset that should be rendered.
8+
9+
**Signature:**
10+
11+
```typescript
12+
asset: DirectusAsset;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md) &gt; [download](./react-directus.directusassetprops.download.md)
4+
5+
## DirectusAssetProps.download property
6+
7+
If the asset should be downloaded instead of rendered.
8+
9+
**Signature:**
10+
11+
```typescript
12+
download?: boolean;
13+
```
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md)
4+
5+
## DirectusAssetProps interface
6+
7+
**Signature:**
8+
9+
```typescript
10+
export interface DirectusAssetProps
11+
```
12+
13+
## Properties
14+
15+
| Property | Modifiers | Type | Description |
16+
| --- | --- | --- | --- |
17+
| [accessToken?](./react-directus.directusassetprops.accesstoken.md) | | string | _(Optional)_ The current user's access token. |
18+
| [apiUrl?](./react-directus.directusassetprops.apiurl.md) | | string | _(Optional)_ url to your Directus instance. |
19+
| [asset](./react-directus.directusassetprops.asset.md) | | [DirectusAsset](./react-directus.directusasset.md) | The asset that should be rendered. |
20+
| [download?](./react-directus.directusassetprops.download.md) | | boolean | _(Optional)_ If the asset should be downloaded instead of rendered. |
21+
| [render](./react-directus.directusassetprops.render.md) | | (args: [DirectusAssetRenderer](./react-directus.directusassetrenderer.md)<!-- -->) =&gt; JSX.Element | A function that returns the React element to be rendered. |
22+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetProps](./react-directus.directusassetprops.md) &gt; [render](./react-directus.directusassetprops.render.md)
4+
5+
## DirectusAssetProps.render property
6+
7+
A function that returns the React element to be rendered.
8+
9+
**Signature:**
10+
11+
```typescript
12+
render: (args: DirectusAssetRenderer) => JSX.Element;
13+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [react-directus](./react-directus.md) &gt; [DirectusAssetRenderer](./react-directus.directusassetrenderer.md)
4+
5+
## DirectusAssetRenderer type
6+
7+
Shape of the `DirectusAsset` component `render` prop.
8+
9+
**Signature:**
10+
11+
```typescript
12+
export type DirectusAssetRenderer = Omit<DirectusAssetProps, 'render'> & {
13+
url?: string;
14+
};
15+
```
16+
**References:** [DirectusAssetProps](./react-directus.directusassetprops.md)
17+

0 commit comments

Comments
 (0)