Skip to content

Commit f59e8fd

Browse files
committed
Improve docs
1 parent 3befa4b commit f59e8fd

39 files changed

+599
-576
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
title: internal
4+
nav_order: 1
5+
---
6+
7+
[React18 Loaders](../../../modules.md) / [client/loader-container/loader-container](README.md) / \<internal\>
8+
9+
# \<internal\>
10+
11+
## Interfaces
12+
13+
### LoaderContainerProps
14+
15+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/client/loader-container/loader-container.tsx#L5)
16+
17+
#### Extends
18+
19+
- `HTMLProps`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>
20+
21+
#### Properties
22+
23+
##### children?
24+
25+
> `optional` **children**: `ReactNode`
26+
27+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/client/loader-container/loader-container.tsx#L6)
28+
29+
###### Overrides
30+
31+
`React.HTMLProps.children`
32+
33+
##### loading?
34+
35+
> `optional` **loading**: `boolean`
36+
37+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/client/loader-container/loader-container.tsx#L7)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[React18 Loaders](../../../modules.md) / client/loader-container/loader-container
2+
3+
# client/loader-container/loader-container
4+
5+
## Modules
6+
7+
- [\<internal\>](-internal-.md)
8+
9+
## Functions
10+
11+
### LoaderContainer()
12+
13+
> **LoaderContainer**(`__namedParameters`): `Element`
14+
15+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/client/loader-container/loader-container.tsx#L14)
16+
17+
# LoaderContainer
18+
19+
A full screen container for the loading animation.
20+
21+
#### Parameters
22+
23+
##### \_\_namedParameters
24+
25+
[`LoaderContainerProps`](-internal-.md#loadercontainerprops)
26+
27+
#### Returns
28+
29+
`Element`
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default
3+
title: README
4+
nav_order: 2
5+
---
6+
7+
[React18 Loaders](../../../modules.md) / client/loader-container/loader-container
8+
9+
# client/loader-container/loader-container
10+
11+
## Modules
12+
13+
- [\<internal\>](-internal-.md)
14+
15+
## Functions
16+
17+
### LoaderContainer()
18+
19+
> **LoaderContainer**(`__namedParameters`): `Element`
20+
21+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/client/loader-container/loader-container.tsx#L14)
22+
23+
# LoaderContainer
24+
25+
A full screen container for the loading animation.
26+
27+
#### Parameters
28+
29+
##### \_\_namedParameters
30+
31+
[`LoaderContainerProps`](-internal-.md#loadercontainerprops)
32+
33+
#### Returns
34+
35+
`Element`
Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
---
22
layout: default
3-
title: constants.LOADER_RGS_KEY
4-
nav_order: 7
3+
title: constants
4+
nav_order: 2
55
---
66

7-
[React18 Loaders](../modules.md) / [constants](../modules/constants.md) / LOADER_RGS_KEY
7+
[React18 Loaders](modules.md) / constants
88

9-
# Variable: LOADER_RGS_KEY
9+
# constants
10+
11+
## Variables
12+
13+
### LOADER_RGS_KEY
1014

1115
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1216
13-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/0b2101a963fc4d82dd719d3ab54362135afb68ad/lib/src/constants.ts#L3)
17+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/3befa4bdc03d40e210600ce1fb6db9a187408521/lib/src/constants.ts#L3)
1418

1519
const uuid = () =\> (Date.now() \* Math.random()).toString(16).slice(2, 8);

docs/functions/client_loader-container_loader-container.LoaderContainer.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/functions/hooks_use-loader.useLoader.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/functions/server_bars_bars1_bars1.Bars1.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/functions/server_bars_bars2_bars2.Bars2.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/functions/server_common_base_base.Base.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/functions/server_dots_dots1_dots1.Dots1.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)