Skip to content

Commit c2e1b7f

Browse files
committed
upgrade deps && docs [skip ci]
1 parent 588bc5c commit c2e1b7f

File tree

18 files changed

+207
-178
lines changed

18 files changed

+207
-178
lines changed

docs/constants.md

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

1212
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1313
14-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/constants.ts#L3)
14+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/constants.ts#L3)
1515

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

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,11 @@ This library is licensed under the MPL-2.0 open-source license.
138138

139139
## Modules
140140

141-
- [client/loader-container/loader-container](client/loader-container/loader-container/index.md)
141+
- [client/loader-container/loader-container](client/loader-container/loader-container/README.md)
142142
- [constants](constants.md)
143143
- [hooks/use-loader](use-loader.md)
144144
- [server/bars/bars1/bars1](server/bars/bars1.md)
145145
- [server/bars/bars2/bars2](server/bars/bars2.md)
146-
- [server/common/base/base](server/common/base/base/index.md)
146+
- [server/common/base/base](server/common/base/base/README.md)
147147
- [server/dots/dots1/dots1](server/dots/dots1.md)
148-
- [server/dots/dots2/dots2](server/dots/dots2/dots2/index.md)
148+
- [server/dots/dots2/dots2](server/dots/dots2/dots2/README.md)

docs/loader-container/-internal-.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 6
1010

1111
### LoaderContainerProps
1212

13-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/client/loader-container/loader-container.tsx#L5)
13+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/client/loader-container/loader-container.tsx#L5)
1414

1515
#### Extends
1616

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

2323
> `optional` **children**: `ReactNode`
2424
25-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/client/loader-container/loader-container.tsx#L6)
25+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/client/loader-container/loader-container.tsx#L6)
2626

2727
###### Overrides
2828

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

3333
> `optional` **loading**: `boolean`
3434
35-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/client/loader-container/loader-container.tsx#L7)
35+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/client/loader-container/loader-container.tsx#L7)

docs/loader-container/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default
3+
title: README
4+
nav_order: 7
5+
has_children: true
6+
---
7+
# client/loader-container/loader-container
8+
9+
## Modules
10+
11+
- [\<internal\>](-internal-.md)
12+
13+
## Functions
14+
15+
### LoaderContainer()
16+
17+
> **LoaderContainer**(`__namedParameters`: [`LoaderContainerProps`](-internal-.md#loadercontainerprops)): `Element`
18+
19+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/client/loader-container/loader-container.tsx#L14)
20+
21+
# LoaderContainer
22+
23+
A full screen container for the loading animation.
24+
25+
#### Parameters
26+
27+
##### \_\_namedParameters
28+
29+
[`LoaderContainerProps`](-internal-.md#loadercontainerprops)
30+
31+
#### Returns
32+
33+
`Element`

docs/loader-container/index.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
11
---
22
layout: default
33
title: Loader Container
4-
nav_order: 5
4+
nav_order: 4
55
has_children: true
66
---
7-
# client/loader-container/loader-container
8-
9-
## Modules
10-
11-
- [\<internal\>](-internal-.md)
12-
13-
## Functions
14-
15-
### LoaderContainer()
16-
17-
> **LoaderContainer**(`__namedParameters`: [`LoaderContainerProps`](-internal-.md#loadercontainerprops)): `Element`
18-
19-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/client/loader-container/loader-container.tsx#L14)
20-
21-
# LoaderContainer
22-
23-
A full screen container for the loading animation.
24-
25-
#### Parameters
26-
27-
##### \_\_namedParameters
28-
29-
[`LoaderContainerProps`](-internal-.md#loadercontainerprops)
30-
31-
#### Returns
32-
33-
`Element`
7+
# Loader Container
8+
- [ Internal ](-internal-.md)
9+
- [README](README.md)

docs/server/bars/bars1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
layout: default
33
title: Bars1
44
parent: Bars
5-
nav_order: 11
5+
nav_order: 12
66
---
77
# server/bars/bars1/bars1
88

99
## Functions
1010

1111
### Bars1()
1212

13-
> **Bars1**(`props`: [`BaseProps`](../../common/base/base/index.md#baseprops)): `Element`
13+
> **Bars1**(`props`: [`BaseProps`](../../common/base/base/README.md#baseprops)): `Element`
1414
15-
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/server/bars/bars1/bars1.tsx#L10)
15+
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/bars/bars1/bars1.tsx#L10)
1616

1717
A simple loader with 3 dots.
1818

1919
#### Parameters
2020

2121
##### props
2222

23-
[`BaseProps`](../../common/base/base/index.md#baseprops)
23+
[`BaseProps`](../../common/base/base/README.md#baseprops)
2424

2525
#### Returns
2626

docs/server/bars/bars2.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
layout: default
33
title: Bars2
44
parent: Bars
5-
nav_order: 12
5+
nav_order: 13
66
---
77
# server/bars/bars2/bars2
88

99
## Functions
1010

1111
### Bars2()
1212

13-
> **Bars2**(`props`: [`BaseProps`](../../common/base/base/index.md#baseprops)): `Element`
13+
> **Bars2**(`props`: [`BaseProps`](../../common/base/base/README.md#baseprops)): `Element`
1414
15-
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/server/bars/bars2/bars2.tsx#L10)
15+
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/bars/bars2/bars2.tsx#L10)
1616

1717
A simple loader with 3 dots.
1818

1919
#### Parameters
2020

2121
##### props
2222

23-
[`BaseProps`](../../common/base/base/index.md#baseprops)
23+
[`BaseProps`](../../common/base/base/README.md#baseprops)
2424

2525
#### Returns
2626

docs/server/bars/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Bars
44
parent: Server
5-
nav_order: 9
5+
nav_order: 10
66
has_children: true
77
---
88
# Bars

docs/server/base/-internal-.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
layout: default
33
title: Internal
44
parent: Base
5-
nav_order: 15
5+
nav_order: 16
66
---
77
# \<internal\>
88

99
## Interfaces
1010

1111
### OtherProps
1212

13-
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/server/common/base/base.tsx#L14)
13+
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L14)
1414

1515
Other props - loaderClass is included here as we will extend BaseProps for other loaders
1616

@@ -20,12 +20,12 @@ Other props - loaderClass is included here as we will extend BaseProps for other
2020

2121
> `optional` **dotRadius**: `string` \| `number`
2222
23-
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/server/common/base/base.tsx#L17)
23+
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L17)
2424

2525
##### loaderClass
2626

2727
> **loaderClass**: `string`
2828
29-
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/3d3c113a28c3ab49589ecce9bf3d54046116994f/lib/src/server/common/base/base.tsx#L16)
29+
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L16)
3030

3131
Loader class name

docs/server/base/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
layout: default
3+
title: README
4+
parent: Server
5+
nav_order: 17
6+
has_children: true
7+
---
8+
# server/common/base/base
9+
10+
## Modules
11+
12+
- [\<internal\>](-internal-.md)
13+
14+
## Interfaces
15+
16+
### BaseProps
17+
18+
Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L4)
19+
20+
Interface declaring the common properties of the loaders
21+
22+
#### Extends
23+
24+
- `HTMLProps`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>
25+
26+
#### Extended by
27+
28+
- [`Dots2Props`](../../../dots/dots2/dots2/-internal-.md#dots2props)
29+
30+
#### Properties
31+
32+
##### color?
33+
34+
> `optional` **color**: `string`
35+
36+
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L10)
37+
38+
Color of the dots - CSS compatible color
39+
40+
###### Overrides
41+
42+
`HTMLProps.color`
43+
44+
##### height?
45+
46+
> `optional` **height**: `string` \| `number`
47+
48+
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L8)
49+
50+
height of the loader element in pixels or a string with a length unit.
51+
52+
###### Overrides
53+
54+
`HTMLProps.height`
55+
56+
##### width?
57+
58+
> `optional` **width**: `string` \| `number`
59+
60+
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L6)
61+
62+
width of the loader element in pixels or a string with a length unit.
63+
64+
###### Overrides
65+
66+
`HTMLProps.width`
67+
68+
## Functions
69+
70+
### Base()
71+
72+
> **Base**(`__namedParameters`: [`BaseProps`](#baseprops) & [`OtherProps`](-internal-.md#otherprops)): `Element`
73+
74+
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/588bc5cb0b13936af4a2e88e171026559ee56e11/lib/src/server/common/base/base.tsx#L25)
75+
76+
Base component to avoid code duplication
77+
78+
default values should be specified in css files - so no need to set them in JSX
79+
80+
#### Parameters
81+
82+
##### \_\_namedParameters
83+
84+
[`BaseProps`](#baseprops) & [`OtherProps`](-internal-.md#otherprops)
85+
86+
#### Returns
87+
88+
`Element`

0 commit comments

Comments
 (0)