Skip to content

Commit c5d923d

Browse files
author
Brandon Scott
committed
0.1.4
1 parent 93d00e6 commit c5d923d

13 files changed

+818
-771
lines changed

‎docs/README.md‎

Lines changed: 651 additions & 604 deletions
Large diffs are not rendered by default.

‎docs/enums/windowevents.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66

77
### Enumeration members
88

9-
* [Resize](windowevents.md#resize)
9+
- [Resize](windowevents.md#resize)
1010

1111
## Enumeration members
1212

13-
### Resize
13+
### Resize
1414

1515
• **Resize**: = "resize"
1616

17-
*Defined in [src/enumerations/window-events.ts:2](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/enumerations/window-events.ts#L2)*
17+
_Defined in [src/enumerations/window-events.ts:2](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/enumerations/window-events.ts#L2)_

‎docs/interfaces/authenticatedroute.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,40 @@
44

55
## Hierarchy
66

7-
* **AuthenticatedRoute**
7+
- **AuthenticatedRoute**
88

9-
↳ [AuthenticatedRouteProps](authenticatedrouteprops.md)
9+
↳ [AuthenticatedRouteProps](authenticatedrouteprops.md)
1010

11-
↳ [NestedRouteProps](nestedrouteprops.md)
11+
↳ [NestedRouteProps](nestedrouteprops.md)
1212

13-
↳ [NestedRoutesProps](nestedroutesprops.md)
13+
↳ [NestedRoutesProps](nestedroutesprops.md)
1414

1515
## Index
1616

1717
### Properties
1818

19-
* [isAuthenticated](authenticatedroute.md#isauthenticated)
20-
* [redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)
19+
- [isAuthenticated](authenticatedroute.md#isauthenticated)
20+
- [redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)
2121

2222
## Properties
2323

24-
### isAuthenticated
24+
### isAuthenticated
2525

26-
• **isAuthenticated**: *boolean*
26+
• **isAuthenticated**: _boolean_
2727

28-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L12)*
28+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L12)_
2929

3030
Flag to determine whether the current user is authenticated or not.
3131

3232
**`memberof`** AuthenticatedRouteProps
3333

34-
___
34+
---
3535

3636
### `Optional` redirectToIfUnauthenticated
3737

38-
• **redirectToIfUnauthenticated**? : *undefined | string*
38+
• **redirectToIfUnauthenticated**? : _undefined | string_
3939

40-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L20)*
40+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L20)_
4141

4242
Route to redirect to if the current user is not authenticated.
4343

‎docs/interfaces/authenticatedrouteprops.md‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,121 +4,121 @@
44

55
## Type parameters
66

7-
▪ **C**: *StaticContext*
7+
▪ **C**: _StaticContext_
88

99
▪ **S**
1010

1111
## Hierarchy
1212

13-
* RouteComponentProps‹any›
13+
- RouteComponentProps‹any›
1414

15-
* [AuthenticatedRoute](authenticatedroute.md)
15+
- [AuthenticatedRoute](authenticatedroute.md)
1616

17-
↳ **AuthenticatedRouteProps**
17+
↳ **AuthenticatedRouteProps**
1818

1919
## Index
2020

2121
### Properties
2222

23-
* [history](authenticatedrouteprops.md#history)
24-
* [isAuthenticated](authenticatedrouteprops.md#isauthenticated)
25-
* [location](authenticatedrouteprops.md#location)
26-
* [match](authenticatedrouteprops.md#match)
27-
* [redirectToIfUnauthenticated](authenticatedrouteprops.md#optional-redirecttoifunauthenticated)
28-
* [render](authenticatedrouteprops.md#render)
29-
* [route](authenticatedrouteprops.md#route)
30-
* [staticContext](authenticatedrouteprops.md#optional-staticcontext)
23+
- [history](authenticatedrouteprops.md#history)
24+
- [isAuthenticated](authenticatedrouteprops.md#isauthenticated)
25+
- [location](authenticatedrouteprops.md#location)
26+
- [match](authenticatedrouteprops.md#match)
27+
- [redirectToIfUnauthenticated](authenticatedrouteprops.md#optional-redirecttoifunauthenticated)
28+
- [render](authenticatedrouteprops.md#render)
29+
- [route](authenticatedrouteprops.md#route)
30+
- [staticContext](authenticatedrouteprops.md#optional-staticcontext)
3131

3232
## Properties
3333

34-
### history
34+
### history
3535

36-
• **history**: *History‹S›*
36+
• **history**: _History‹S›_
3737

38-
*Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[history](authenticatedrouteprops.md#history)*
38+
_Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[history](authenticatedrouteprops.md#history)_
3939

4040
Defined in node_modules/@types/react-router/index.d.ts:75
4141

42-
___
42+
---
4343

44-
### isAuthenticated
44+
### isAuthenticated
4545

46-
• **isAuthenticated**: *boolean*
46+
• **isAuthenticated**: _boolean_
4747

48-
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)*
48+
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)_
4949

50-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L12)*
50+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L12)_
5151

5252
Flag to determine whether the current user is authenticated or not.
5353

5454
**`memberof`** AuthenticatedRouteProps
5555

56-
___
56+
---
5757

58-
### location
58+
### location
5959

60-
• **location**: *Location‹S›*
60+
• **location**: _Location‹S›_
6161

62-
*Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[location](authenticatedrouteprops.md#location)*
62+
_Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[location](authenticatedrouteprops.md#location)_
6363

6464
Defined in node_modules/@types/react-router/index.d.ts:76
6565

66-
___
66+
---
6767

68-
### match
68+
### match
6969

70-
• **match**: *match‹any›*
70+
• **match**: _match‹any›_
7171

72-
*Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[match](authenticatedrouteprops.md#match)*
72+
_Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[match](authenticatedrouteprops.md#match)_
7373

7474
Defined in node_modules/@types/react-router/index.d.ts:77
7575

76-
___
76+
---
7777

7878
### `Optional` redirectToIfUnauthenticated
7979

80-
• **redirectToIfUnauthenticated**? : *undefined | string*
80+
• **redirectToIfUnauthenticated**? : _undefined | string_
8181

82-
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)*
82+
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)_
8383

84-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L20)*
84+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L20)_
8585

8686
Route to redirect to if the current user is not authenticated.
8787

8888
**`memberof`** UnauthenticatedRedirectProps
8989

90-
___
90+
---
9191

92-
### render
92+
### render
9393

94-
• **render**: *function*
94+
• **render**: _function_
9595

96-
*Defined in [src/components/routing/authenticated-route.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/components/routing/authenticated-route.tsx#L14)*
96+
_Defined in [src/components/routing/authenticated-route.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/components/routing/authenticated-route.tsx#L14)_
9797

9898
#### Type declaration:
9999

100-
▸ (`props`: any): *any*
100+
▸ (`props`: any): _any_
101101

102102
**Parameters:**
103103

104-
Name | Type |
105-
------ | ------ |
106-
`props` | any |
104+
| Name | Type |
105+
| ------- | ---- |
106+
| `props` | any |
107107

108-
___
108+
---
109109

110-
### route
110+
### route
111111

112-
• **route**: *[RouteDefinition](routedefinition.md)*
112+
• **route**: _[RouteDefinition](routedefinition.md)_
113113

114-
*Defined in [src/components/routing/authenticated-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/components/routing/authenticated-route.tsx#L13)*
114+
_Defined in [src/components/routing/authenticated-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/components/routing/authenticated-route.tsx#L13)_
115115

116-
___
116+
---
117117

118118
### `Optional` staticContext
119119

120-
• **staticContext**? : *C*
120+
• **staticContext**? : _C_
121121

122-
*Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[staticContext](authenticatedrouteprops.md#optional-staticcontext)*
122+
_Inherited from [AuthenticatedRouteProps](authenticatedrouteprops.md).[staticContext](authenticatedrouteprops.md#optional-staticcontext)_
123123

124124
Defined in node_modules/@types/react-router/index.d.ts:78

‎docs/interfaces/nestedrouteprops.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,50 @@
44

55
## Hierarchy
66

7-
* [AuthenticatedRoute](authenticatedroute.md)
7+
- [AuthenticatedRoute](authenticatedroute.md)
88

9-
↳ **NestedRouteProps**
9+
↳ **NestedRouteProps**
1010

1111
## Index
1212

1313
### Properties
1414

15-
* [isAuthenticated](nestedrouteprops.md#isauthenticated)
16-
* [redirectToIfUnauthenticated](nestedrouteprops.md#optional-redirecttoifunauthenticated)
17-
* [route](nestedrouteprops.md#route)
15+
- [isAuthenticated](nestedrouteprops.md#isauthenticated)
16+
- [redirectToIfUnauthenticated](nestedrouteprops.md#optional-redirecttoifunauthenticated)
17+
- [route](nestedrouteprops.md#route)
1818

1919
## Properties
2020

21-
### isAuthenticated
21+
### isAuthenticated
2222

23-
• **isAuthenticated**: *boolean*
23+
• **isAuthenticated**: _boolean_
2424

25-
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)*
25+
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)_
2626

27-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L12)*
27+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L12)_
2828

2929
Flag to determine whether the current user is authenticated or not.
3030

3131
**`memberof`** AuthenticatedRouteProps
3232

33-
___
33+
---
3434

3535
### `Optional` redirectToIfUnauthenticated
3636

37-
• **redirectToIfUnauthenticated**? : *undefined | string*
37+
• **redirectToIfUnauthenticated**? : _undefined | string_
3838

39-
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)*
39+
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)_
4040

41-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/interfaces/authenticated-route.ts#L20)*
41+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/interfaces/authenticated-route.ts#L20)_
4242

4343
Route to redirect to if the current user is not authenticated.
4444

4545
**`memberof`** UnauthenticatedRedirectProps
4646

47-
___
47+
---
4848

49-
### route
49+
### route
5050

51-
• **route**: *[RouteDefinition](routedefinition.md)*
51+
• **route**: _[RouteDefinition](routedefinition.md)_
5252

53-
*Defined in [src/components/routing/nested-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/components/routing/nested-route.tsx#L13)*
53+
_Defined in [src/components/routing/nested-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/components/routing/nested-route.tsx#L13)_

‎docs/interfaces/nestedroutesbypropertyprops.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44

55
## Hierarchy
66

7-
* **NestedRoutesByPropertyProps**
7+
- **NestedRoutesByPropertyProps**
88

99
## Index
1010

1111
### Properties
1212

13-
* [propertyName](nestedroutesbypropertyprops.md#propertyname)
14-
* [routes](nestedroutesbypropertyprops.md#routes)
13+
- [propertyName](nestedroutesbypropertyprops.md#propertyname)
14+
- [routes](nestedroutesbypropertyprops.md#routes)
1515

1616
## Properties
1717

18-
### propertyName
18+
### propertyName
1919

20-
• **propertyName**: *keyof RouteDefinition*
20+
• **propertyName**: _keyof RouteDefinition_
2121

22-
*Defined in [src/components/routing/nested-routes-by-property.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/components/routing/nested-routes-by-property.tsx#L14)*
22+
_Defined in [src/components/routing/nested-routes-by-property.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/components/routing/nested-routes-by-property.tsx#L14)_
2323

24-
___
24+
---
2525

26-
### routes
26+
### routes
2727

28-
• **routes**: *[RouteDefinition](routedefinition.md)[]*
28+
• **routes**: _[RouteDefinition](routedefinition.md)[]_
2929

30-
*Defined in [src/components/routing/nested-routes-by-property.tsx:15](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0725a3f/src/components/routing/nested-routes-by-property.tsx#L15)*
30+
_Defined in [src/components/routing/nested-routes-by-property.tsx:15](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/93d00e6/src/components/routing/nested-routes-by-property.tsx#L15)_

0 commit comments

Comments
 (0)