Skip to content

Commit e8bb784

Browse files
committed
update docs
1 parent 747f592 commit e8bb784

13 files changed

Lines changed: 28 additions & 35 deletions

File tree

docs/client/loader-container/loader-container/-internal-.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Internal
4-
parent: Loader Container
54
nav_order: 5
65
---
76

@@ -13,7 +12,7 @@ nav_order: 5
1312

1413
### LoaderContainerProps
1514

16-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/client/loader-container/loader-container.tsx#L5)
15+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/client/loader-container/loader-container.tsx#L5)
1716

1817
#### Extends
1918

@@ -25,7 +24,7 @@ Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/
2524

2625
> `optional` **children**: `ReactNode`
2726
28-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/client/loader-container/loader-container.tsx#L6)
27+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/client/loader-container/loader-container.tsx#L6)
2928

3029
###### Overrides
3130

@@ -35,4 +34,4 @@ Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/
3534

3635
> `optional` **loading**: `boolean`
3736
38-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/client/loader-container/loader-container.tsx#L7)
37+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/client/loader-container/loader-container.tsx#L7)

docs/client/loader-container/loader-container/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Loader Container
4-
parent: Loader Container
54
nav_order: 4
65
---
76

@@ -19,7 +18,7 @@ nav_order: 4
1918

2019
> **LoaderContainer**(`__namedParameters`): `Element`
2120
22-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/client/loader-container/loader-container.tsx#L14)
21+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/client/loader-container/loader-container.tsx#L14)
2322

2423
# LoaderContainer
2524

docs/constants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ nav_order: 2
1414

1515
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1616
17-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/constants.ts#L3)
17+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/constants.ts#L3)
1818

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

docs/hooks/use-loader.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Use Loader
4-
parent: Hooks
54
nav_order: 6
65
---
76

@@ -15,7 +14,7 @@ nav_order: 6
1514

1615
> **useLoader**(): `object`
1716
18-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/hooks/use-loader.ts#L8)
17+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/hooks/use-loader.ts#L8)
1918

2019
#### Returns
2120

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: React18 Loaders
3+
title: React 18 Loaders
44
nav_order: 1
55
---
66

docs/server/bars/bars1/bars1.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Bars1
4-
parent: Bars1
54
nav_order: 7
65
---
76

@@ -15,7 +14,7 @@ nav_order: 7
1514

1615
> **Bars1**(`props`): `Element`
1716
18-
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/bars/bars1/bars1.tsx#L10)
17+
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/bars/bars1/bars1.tsx#L10)
1918

2019
A simple loader with 3 dots.
2120

docs/server/bars/bars2/bars2.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Bars2
4-
parent: Bars2
54
nav_order: 8
65
---
76

@@ -15,7 +14,7 @@ nav_order: 8
1514

1615
> **Bars2**(`props`): `Element`
1716
18-
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/bars/bars2/bars2.tsx#L10)
17+
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/bars/bars2/bars2.tsx#L10)
1918

2019
A simple loader with 3 dots.
2120

docs/server/common/base/base/-internal-.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Internal
4-
parent: Base
54
nav_order: 10
65
---
76

@@ -13,7 +12,7 @@ nav_order: 10
1312

1413
### OtherProps
1514

16-
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L14)
15+
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L14)
1716

1817
Other props - loaderClass is included here as we will extend BaseProps for other loaders
1918

@@ -23,12 +22,12 @@ Other props - loaderClass is included here as we will extend BaseProps for other
2322

2423
> `optional` **dotRadius**: `string` \| `number`
2524
26-
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L17)
25+
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L17)
2726

2827
##### loaderClass
2928

3029
> **loaderClass**: `string`
3130
32-
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L16)
31+
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L16)
3332

3433
Loader class name

docs/server/common/base/base/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Base
4-
parent: Base
54
nav_order: 9
65
---
76

@@ -17,7 +16,7 @@ nav_order: 9
1716

1817
### BaseProps
1918

20-
Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L4)
19+
Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L4)
2120

2221
Interface declaring the common properties of the loaders
2322

@@ -35,7 +34,7 @@ Interface declaring the common properties of the loaders
3534

3635
> `optional` **color**: `string`
3736
38-
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L10)
37+
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L10)
3938

4039
Color of the dots - CSS compatible color
4140

@@ -47,7 +46,7 @@ Color of the dots - CSS compatible color
4746

4847
> `optional` **height**: `string` \| `number`
4948
50-
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L8)
49+
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L8)
5150

5251
height of the loader element in pixels or a string with a length unit.
5352

@@ -59,7 +58,7 @@ height of the loader element in pixels or a string with a length unit.
5958

6059
> `optional` **width**: `string` \| `number`
6160
62-
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L6)
61+
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L6)
6362

6463
width of the loader element in pixels or a string with a length unit.
6564

@@ -73,7 +72,7 @@ width of the loader element in pixels or a string with a length unit.
7372

7473
> **Base**(`__namedParameters`): `Element`
7574
76-
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/common/base/base.tsx#L25)
75+
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/common/base/base.tsx#L25)
7776

7877
Base component to avoid code duplication
7978

docs/server/dots/dots1/dots1.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Dots1
4-
parent: Dots1
54
nav_order: 11
65
---
76

@@ -15,7 +14,7 @@ nav_order: 11
1514

1615
> **Dots1**(`props`): `Element`
1716
18-
Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/a7a0f3110cb0811f0408f193a24e25977470a635/lib/src/server/dots/dots1/dots1.tsx#L10)
17+
Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/747f592135576f89d486d5b401dbafe70b5452cc/lib/src/server/dots/dots1/dots1.tsx#L10)
1918

2019
A simple loader with 3 dots.
2120

0 commit comments

Comments
 (0)