Skip to content

Commit 0b2101a

Browse files
committed
fix docs
1 parent 953a44c commit 0b2101a

Some content is hidden

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

47 files changed

+632
-473
lines changed

docs/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
layout: default
3-
title: README
4-
---
5-
61
# React18 Loaders <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
72

83
[![test](https://github.com/react18-tools/turborepo-template/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/turborepo-template/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/turborepo-template/maintainability) [![codecov](https://codecov.io/gh/react18-tools/turborepo-template/graph/badge.svg)](https://codecov.io/gh/react18-tools/turborepo-template) [![Version](https://img.shields.io/npm/v/react18-loaders.svg?colorB=green)](https://www.npmjs.com/package/react18-loaders) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/react18-loaders.svg)](https://www.npmjs.com/package/react18-loaders) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react18-loaders) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

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

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

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

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

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

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

docs/client/loader-container/loader-container/functions/LoaderContainer.md

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: default
3+
title: client_loader container_loader container.LoaderContainer
4+
nav_order: 1
5+
---
6+
7+
[React18 Loaders](../modules.md) / [client/loader-container/loader-container](../modules/client_loader-container_loader-container.md) / LoaderContainer
8+
9+
# Function: LoaderContainer()
10+
11+
> **LoaderContainer**(`__namedParameters`): `Element`
12+
13+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/953a44c1588ec5b26e28b0a1cff724c01bff4526/lib/src/client/loader-container/loader-container.tsx#L14)
14+
15+
# LoaderContainer
16+
17+
A full screen container for the loading animation.
18+
19+
## Parameters
20+
21+
### \_\_namedParameters
22+
23+
[`LoaderContainerProps`](../interfaces/client_loader-container_loader-container._internal_.LoaderContainerProps.md)
24+
25+
## Returns
26+
27+
`Element`

docs/hooks/use-loader/functions/useLoader.md renamed to docs/functions/hooks_use-loader.useLoader.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
layout: default
3-
title: useLoader
3+
title: hooks_use loader.useLoader
4+
nav_order: 2
45
---
56

6-
[React18 Loaders](../../../modules.md) / [hooks/use-loader](../README.md) / useLoader
7+
[React18 Loaders](../modules.md) / [hooks/use-loader](../modules/hooks_use-loader.md) / useLoader
78

89
# Function: useLoader()
910

1011
> **useLoader**(): `object`
1112
12-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/4860f8f3bf634e2ab10522ee4176777316d032d4/lib/src/hooks/use-loader.ts#L8)
13+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/953a44c1588ec5b26e28b0a1cff724c01bff4526/lib/src/hooks/use-loader.ts#L8)
1314

1415
## Returns
1516

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default
3+
title: server_bars_bars1_bars1.Bars1
4+
nav_order: 3
5+
---
6+
7+
[React18 Loaders](../modules.md) / [server/bars/bars1/bars1](../modules/server_bars_bars1_bars1.md) / Bars1
8+
9+
# Function: Bars1()
10+
11+
> **Bars1**(`props`): `Element`
12+
13+
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/953a44c1588ec5b26e28b0a1cff724c01bff4526/lib/src/server/bars/bars1/bars1.tsx#L10)
14+
15+
A simple loader with 3 dots.
16+
17+
## Parameters
18+
19+
### props
20+
21+
[`BaseProps`](../interfaces/server_common_base_base.BaseProps.md)
22+
23+
## Returns
24+
25+
`Element`
26+
27+
## Example
28+
29+
```ts
30+
<Bars1 />
31+
```
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default
3+
title: server_bars_bars2_bars2.Bars2
4+
nav_order: 4
5+
---
6+
7+
[React18 Loaders](../modules.md) / [server/bars/bars2/bars2](../modules/server_bars_bars2_bars2.md) / Bars2
8+
9+
# Function: Bars2()
10+
11+
> **Bars2**(`props`): `Element`
12+
13+
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/953a44c1588ec5b26e28b0a1cff724c01bff4526/lib/src/server/bars/bars2/bars2.tsx#L10)
14+
15+
A simple loader with 3 dots.
16+
17+
## Parameters
18+
19+
### props
20+
21+
[`BaseProps`](../interfaces/server_common_base_base.BaseProps.md)
22+
23+
## Returns
24+
25+
`Element`
26+
27+
## Example
28+
29+
```ts
30+
<Bars2 />
31+
```
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: default
3+
title: server_common_base_base.Base
4+
nav_order: 5
5+
---
6+
7+
[React18 Loaders](../modules.md) / [server/common/base/base](../modules/server_common_base_base.md) / Base
8+
9+
# Function: Base()
10+
11+
> **Base**(`__namedParameters`): `Element`
12+
13+
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/953a44c1588ec5b26e28b0a1cff724c01bff4526/lib/src/server/common/base/base.tsx#L25)
14+
15+
Base component to avoid code duplication
16+
17+
default values should be specified in css files - so no need to set them in JSX
18+
19+
## Parameters
20+
21+
### \_\_namedParameters
22+
23+
[`BaseProps`](../interfaces/server_common_base_base.BaseProps.md) & [`OtherProps`](../interfaces/server_common_base_base._internal_.OtherProps.md)
24+
25+
## Returns
26+
27+
`Element`

0 commit comments

Comments
 (0)