Skip to content

Commit 8756848

Browse files
author
Brandon Scott
committed
0.2.0
1 parent 1eccb7a commit 8756848

14 files changed

+227
-108
lines changed

‎docs/README.md‎

Lines changed: 124 additions & 76 deletions
Large diffs are not rendered by default.

‎docs/enums/windowevents.md‎

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

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

17-
_Defined in [src/enumerations/window-events.ts:2](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/enumerations/window-events.ts#L2)_
17+
_Defined in [src/enumerations/window-events.ts:2](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/enumerations/window-events.ts#L2)_

‎docs/interfaces/authenticatedroute.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
• **isAuthenticated**: _boolean_
2727

28-
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/authenticated-route.ts#L12)_
28+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L12)_
2929

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

@@ -37,7 +37,7 @@ Flag to determine whether the current user is authenticated or not.
3737

3838
• **redirectToIfUnauthenticated**? : _undefined | string_
3939

40-
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/authenticated-route.ts#L20)_
40+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Defined in node_modules/@types/react-router/index.d.ts:75
4747

4848
_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/0bc294c/src/interfaces/authenticated-route.ts#L12)_
50+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L12)_
5151

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

@@ -81,7 +81,7 @@ Defined in node_modules/@types/react-router/index.d.ts:77
8181

8282
_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/0bc294c/src/interfaces/authenticated-route.ts#L20)_
84+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L20)_
8585

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

@@ -93,7 +93,7 @@ Route to redirect to if the current user is not authenticated.
9393

9494
• **render**: _function_
9595

96-
_Defined in [src/components/routing/authenticated-route.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/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/1eccb7a/src/components/routing/authenticated-route.tsx#L14)_
9797

9898
#### Type declaration:
9999

@@ -111,7 +111,7 @@ _Defined in [src/components/routing/authenticated-route.tsx:14](https://github.c
111111

112112
• **route**: _[RouteDefinition](routedefinition.md)_
113113

114-
_Defined in [src/components/routing/authenticated-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/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/1eccb7a/src/components/routing/authenticated-route.tsx#L13)_
115115

116116
---
117117

‎docs/interfaces/nestedrouteprops.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
_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/0bc294c/src/interfaces/authenticated-route.ts#L12)_
27+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L12)_
2828

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

@@ -38,7 +38,7 @@ Flag to determine whether the current user is authenticated or not.
3838

3939
_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/0bc294c/src/interfaces/authenticated-route.ts#L20)_
41+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L20)_
4242

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

@@ -50,4 +50,4 @@ Route to redirect to if the current user is not authenticated.
5050

5151
• **route**: _[RouteDefinition](routedefinition.md)_
5252

53-
_Defined in [src/components/routing/nested-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/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/1eccb7a/src/components/routing/nested-route.tsx#L13)_

‎docs/interfaces/nestedroutesbypropertyprops.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
• **propertyName**: _keyof RouteDefinition_
2121

22-
_Defined in [src/components/routing/nested-routes-by-property.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/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/1eccb7a/src/components/routing/nested-routes-by-property.tsx#L14)_
2323

2424
---
2525

2626
### routes
2727

2828
• **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/0bc294c/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/1eccb7a/src/components/routing/nested-routes-by-property.tsx#L15)_

‎docs/interfaces/nestedroutesprops.md‎

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

2828
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)_
2929

30-
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/authenticated-route.ts#L12)_
30+
_Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L12)_
3131

3232
Flag to determine whether the current user is authenticated or not.
3333

@@ -41,7 +41,7 @@ Flag to determine whether the current user is authenticated or not.
4141

4242
_Inherited from [UnmatchedRoute](unmatchedroute.md).[redirectToIfNotFound](unmatchedroute.md#optional-redirecttoifnotfound)_
4343

44-
_Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/unmatched-route.ts#L12)_
44+
_Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/unmatched-route.ts#L12)_
4545

4646
Route to redirect to if the specified route cannot be matched.
4747

@@ -55,7 +55,7 @@ Route to redirect to if the specified route cannot be matched.
5555

5656
_Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)_
5757

58-
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/authenticated-route.ts#L20)_
58+
_Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/authenticated-route.ts#L20)_
5959

6060
Route to redirect to if the current user is not authenticated.
6161

@@ -67,4 +67,4 @@ Route to redirect to if the current user is not authenticated.
6767

6868
• **routes**: _[RouteDefinition](routedefinition.md)[]_
6969

70-
_Defined in [src/components/routing/nested-routes.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/components/routing/nested-routes.tsx#L14)_
70+
_Defined in [src/components/routing/nested-routes.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/components/routing/nested-routes.tsx#L14)_

‎docs/interfaces/redirectdefinition.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
• **from**: _string_
2121

22-
_Defined in [src/interfaces/redirect-definition.ts:6](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/redirect-definition.ts#L6)_
22+
_Defined in [src/interfaces/redirect-definition.ts:6](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/redirect-definition.ts#L6)_
2323

2424
---
2525

2626
### to
2727

2828
• **to**: _string_
2929

30-
_Defined in [src/interfaces/redirect-definition.ts:7](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/redirect-definition.ts#L7)_
30+
_Defined in [src/interfaces/redirect-definition.ts:7](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/redirect-definition.ts#L7)_

‎docs/interfaces/redirectsprops.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818

1919
• **redirects**: _[RedirectDefinition](redirectdefinition.md)[]_
2020

21-
_Defined in [src/components/routing/redirects.tsx:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/components/routing/redirects.tsx#L10)_
21+
_Defined in [src/components/routing/redirects.tsx:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/components/routing/redirects.tsx#L10)_

‎docs/interfaces/routedefinition.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,52 +24,52 @@
2424

2525
• **authRequired**: _boolean_
2626

27-
_Defined in [src/interfaces/route-definition.ts:9](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L9)_
27+
_Defined in [src/interfaces/route-definition.ts:9](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L9)_
2828

2929
---
3030

3131
### component
3232

3333
• **component**: _React.ComponentType_
3434

35-
_Defined in [src/interfaces/route-definition.ts:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L10)_
35+
_Defined in [src/interfaces/route-definition.ts:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L10)_
3636

3737
---
3838

3939
### `Optional` exact
4040

4141
• **exact**? : _undefined | false | true_
4242

43-
_Defined in [src/interfaces/route-definition.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L11)_
43+
_Defined in [src/interfaces/route-definition.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L11)_
4444

4545
---
4646

4747
### `Optional` getComponent
4848

4949
• **getComponent**? : _undefined | function_
5050

51-
_Defined in [src/interfaces/route-definition.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L12)_
51+
_Defined in [src/interfaces/route-definition.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L12)_
5252

5353
---
5454

5555
### path
5656

5757
• **path**: _string_
5858

59-
_Defined in [src/interfaces/route-definition.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L13)_
59+
_Defined in [src/interfaces/route-definition.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L13)_
6060

6161
---
6262

6363
### routes
6464

6565
• **routes**: _[RouteMap](routemap.md)_
6666

67-
_Defined in [src/interfaces/route-definition.ts:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L14)_
67+
_Defined in [src/interfaces/route-definition.ts:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L14)_
6868

6969
---
7070

7171
### `Optional` sidebar
7272

7373
• **sidebar**? : _React.ComponentType_
7474

75-
_Defined in [src/interfaces/route-definition.ts:16](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/0bc294c/src/interfaces/route-definition.ts#L16)_
75+
_Defined in [src/interfaces/route-definition.ts:16](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/1eccb7a/src/interfaces/route-definition.ts#L16)_

0 commit comments

Comments
 (0)