Skip to content

Commit 9b2798f

Browse files
mayank1513mayank1513
committed
Update docs
1 parent 3815bf5 commit 9b2798f

26 files changed

Lines changed: 37 additions & 135 deletions

File tree

‎docs/README.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
**React18 Loaders**
2-
3-
***
4-
51
# React18 Loaders <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
62

73
[![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/_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
remote_theme: just-the-docs/just-the-docs

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
[**React18 Loaders**](../../../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../../../modules.md) / [client/loader-container/loader-container](../README.md) / \<internal\>
62

73
# \<internal\>

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
[**React18 Loaders**](../../../../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../../../../modules.md) / [client/loader-container/loader-container](../../README.md) / [\<internal\>](../README.md) / LoaderContainerProps
62

73
# Interface: LoaderContainerProps
84

9-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/client/loader-container/loader-container.tsx#L5)
5+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/client/loader-container/loader-container.tsx#L5)
106

117
## Extends
128

@@ -18,16 +14,16 @@ Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/
1814

1915
> `optional` **children**: `ReactNode`
2016
21-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/client/loader-container/loader-container.tsx#L6)
17+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/client/loader-container/loader-container.tsx#L6)
2218

2319
#### Overrides
2420

2521
`React.HTMLProps.children`
2622

27-
***
23+
---
2824

2925
### loading?
3026

3127
> `optional` **loading**: `boolean`
3228
33-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/client/loader-container/loader-container.tsx#L7)
29+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/client/loader-container/loader-container.tsx#L7)

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
[**React18 Loaders**](../../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../../modules.md) / client/loader-container/loader-container
62

73
# client/loader-container/loader-container

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
[**React18 Loaders**](../../../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../../../modules.md) / [client/loader-container/loader-container](../README.md) / LoaderContainer
62

73
# Function: LoaderContainer()
84

95
> **LoaderContainer**(`__namedParameters`): `Element`
106
11-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/client/loader-container/loader-container.tsx#L14)
7+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/client/loader-container/loader-container.tsx#L14)
128

139
# LoaderContainer
10+
1411
A full screen container for the loading animation.
1512

1613
## Parameters

‎docs/constants/README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
[**React18 Loaders**](../README.md)
2-
3-
***
4-
51
[React18 Loaders](../modules.md) / constants
62

73
# constants
84

95
## Variables
106

11-
- [LOADER\_RGS\_KEY](variables/LOADER_RGS_KEY.md)
7+
- [LOADER_RGS_KEY](variables/LOADER_RGS_KEY.md)

‎docs/constants/variables/LOADER_RGS_KEY.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
[**React18 Loaders**](../../README.md)
1+
[React18 Loaders](../../modules.md) / [constants](../README.md) / LOADER_RGS_KEY
22

3-
***
3+
# Variable: LOADER_RGS_KEY
44

5-
[React18 Loaders](../../modules.md) / [constants](../README.md) / LOADER\_RGS\_KEY
5+
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
66
7-
# Variable: LOADER\_RGS\_KEY
7+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/constants.ts#L3)
88

9-
> `const` **LOADER\_RGS\_KEY**: `"r18-loaders"` = `"r18-loaders"`
10-
11-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/constants.ts#L3)
12-
13-
const uuid = () => (Date.now() * Math.random()).toString(16).slice(2, 8);
9+
const uuid = () =\> (Date.now() \* Math.random()).toString(16).slice(2, 8);

‎docs/hooks/use-loader/README.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
[**React18 Loaders**](../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../modules.md) / hooks/use-loader
62

73
# hooks/use-loader

‎docs/hooks/use-loader/functions/useLoader.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
[**React18 Loaders**](../../../README.md)
2-
3-
***
4-
51
[React18 Loaders](../../../modules.md) / [hooks/use-loader](../README.md) / useLoader
62

73
# Function: useLoader()
84

95
> **useLoader**(): `object`
106
11-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/15f049b3490b4e059828906d31f43a3bb780bbbe/lib/src/hooks/use-loader.ts#L8)
7+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/59e71c9c47952d89d130580522ad77f57cd1f4be/lib/src/hooks/use-loader.ts#L8)
128

139
## Returns
1410

0 commit comments

Comments
 (0)