diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5913d7b..ca5dc4a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,7 +19,11 @@ jobs: with: version: 10.31.0 - name: Build JS docs - run: cd lineup-client && pnpm install && pnpm exec typedoc + run: | + cd lineup-client + pnpm install + pnpm exec typedoc + cp docs-toc.yml docs/toc.yml - name: Restore dependencies run: dotnet restore && dotnet tool restore - name: Build Documentation diff --git a/.gitignore b/.gitignore index 0a966f8..309cb81 100644 --- a/.gitignore +++ b/.gitignore @@ -213,3 +213,4 @@ openapi-spec/ # docfx api/ _site/ +lineup-client/docs/toc.yml diff --git a/index.md b/index.md index 2e34b03..d650f6a 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,10 @@ _layout: landing --- # LineUp Documentation -See the top bar to navigate between client/server documentation. -A demo instance of LineUp is available at [lineup.rem.bi](https://lineup.rem.bi). \ No newline at end of file +- **[Client API Documentation](/client-docs/)** +- **[Server API Documentation](/api/LineUp.AppHost.html)** + +Or, see the top bar to navigate between client/server documentation. + +A demo instance of LineUp is available at [lineup.rem.bi](https://lineup.rem.bi). diff --git a/lineup-client/docs/toc.yml b/lineup-client/client-toc.yml similarity index 100% rename from lineup-client/docs/toc.yml rename to lineup-client/client-toc.yml diff --git a/lineup-client/docs/App/functions/default.md b/lineup-client/docs/App/functions/default.md index 2697312..c6418b7 100644 --- a/lineup-client/docs/App/functions/default.md +++ b/lineup-client/docs/App/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [App.tsx:85](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/App.tsx#L85) +Defined in: [App.tsx:85](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/App.tsx#L85) The main application shell. Renders the router and global providers. diff --git a/lineup-client/docs/components/Calendar/functions/Calendar.md b/lineup-client/docs/components/Calendar/functions/Calendar.md index 24d83bf..6752658 100644 --- a/lineup-client/docs/components/Calendar/functions/Calendar.md +++ b/lineup-client/docs/components/Calendar/functions/Calendar.md @@ -8,7 +8,7 @@ > **Calendar**(`props`): `Element` -Defined in: [components/Calendar.tsx:56](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L56) +Defined in: [components/Calendar.tsx:56](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L56) A calendar that renders rows and columns based on the input times, putting the chosen [Cell](../../CalendarCells/index.md) in each one. diff --git a/lineup-client/docs/components/Calendar/interfaces/CalendarProps.md b/lineup-client/docs/components/Calendar/interfaces/CalendarProps.md index d9f5d67..4fbdfd4 100644 --- a/lineup-client/docs/components/Calendar/interfaces/CalendarProps.md +++ b/lineup-client/docs/components/Calendar/interfaces/CalendarProps.md @@ -6,7 +6,7 @@ # Interface: CalendarProps -Defined in: [components/Calendar.tsx:18](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L18) +Defined in: [components/Calendar.tsx:18](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L18) Props for the [Calendar](../functions/Calendar.md) component. @@ -16,7 +16,7 @@ Props for the [Calendar](../functions/Calendar.md) component. > **Cell**: `ComponentType`\<[`CalendarCellProps`](../../CalendarCells/interfaces/CalendarCellProps.md)\> -Defined in: [components/Calendar.tsx:20](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L20) +Defined in: [components/Calendar.tsx:20](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L20) The Cell that chooses behavior, rendered in each row/column. @@ -26,7 +26,7 @@ The Cell that chooses behavior, rendered in each row/column. > `optional` **colors?**: `object` -Defined in: [components/Calendar.tsx:34](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L34) +Defined in: [components/Calendar.tsx:34](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L34) Map of UTC timestamps to CSS colors. @@ -46,7 +46,7 @@ Map of UTC timestamps to CSS colors. > **dates**: `Date`[] -Defined in: [components/Calendar.tsx:26](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L26) +Defined in: [components/Calendar.tsx:26](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L26) Array of dates (columns) for the calendar. Time input does not matter. @@ -56,7 +56,7 @@ Array of dates (columns) for the calendar. Time input does not matter. > **minutesPerCell**: [`ValidMinutes`](../../../types/type-aliases/ValidMinutes.md) -Defined in: [components/Calendar.tsx:23](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L23) +Defined in: [components/Calendar.tsx:23](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L23) Number of minutes each cell represents. @@ -66,7 +66,7 @@ Number of minutes each cell represents. > **range**: [`TimeRange`](../../../types/type-aliases/TimeRange.md) -Defined in: [components/Calendar.tsx:29](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L29) +Defined in: [components/Calendar.tsx:29](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L29) Start time of first cell to end time of last cell. @@ -76,7 +76,7 @@ Start time of first cell to end time of last cell. > `optional` **selectedCells?**: `string`[] -Defined in: [components/Calendar.tsx:45](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L45) +Defined in: [components/Calendar.tsx:45](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L45) Array of UTC timestamps for which cells are shown as selected. @@ -86,7 +86,7 @@ Array of UTC timestamps for which cells are shown as selected. > `optional` **setFocusedCell?**: `Dispatch`\<`SetStateAction`\<`string` \| `null`\>\> -Defined in: [components/Calendar.tsx:42](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L42) +Defined in: [components/Calendar.tsx:42](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L42) React state setter to update which cell a user is currently focusing over. Sets `null` when not hovering over a cell. @@ -96,7 +96,7 @@ React state setter to update which cell a user is currently focusing over. Sets > `optional` **setSelectedCells?**: `Dispatch`\<`SetStateAction`\<`string`[]\>\> -Defined in: [components/Calendar.tsx:48](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L48) +Defined in: [components/Calendar.tsx:48](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L48) React state setter for [selectedCells](#selectedcells). @@ -106,7 +106,7 @@ React state setter for [selectedCells](#selectedcells). > `optional` **text?**: `object` -Defined in: [components/Calendar.tsx:39](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Calendar.tsx#L39) +Defined in: [components/Calendar.tsx:39](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Calendar.tsx#L39) Map of UTC timestamps to text displayed on the cell. diff --git a/lineup-client/docs/components/CalendarCells/functions/ColoredCell.md b/lineup-client/docs/components/CalendarCells/functions/ColoredCell.md index 52e36a0..58f6434 100644 --- a/lineup-client/docs/components/CalendarCells/functions/ColoredCell.md +++ b/lineup-client/docs/components/CalendarCells/functions/ColoredCell.md @@ -8,7 +8,7 @@ > **ColoredCell**(`props`): `Element` -Defined in: [components/CalendarCells.tsx:117](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L117) +Defined in: [components/CalendarCells.tsx:117](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L117) A cell type that is colored based on the provided input and includes text information, but cannot be clicked. diff --git a/lineup-client/docs/components/CalendarCells/functions/FillableCell.md b/lineup-client/docs/components/CalendarCells/functions/FillableCell.md index af5f94d..0e9d573 100644 --- a/lineup-client/docs/components/CalendarCells/functions/FillableCell.md +++ b/lineup-client/docs/components/CalendarCells/functions/FillableCell.md @@ -8,7 +8,7 @@ > **FillableCell**(`props`): `Element` -Defined in: [components/CalendarCells.tsx:45](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L45) +Defined in: [components/CalendarCells.tsx:45](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L45) A cell type that can be selected/deselected to indicate availability, including support for clicking and dragging across multiple cells. diff --git a/lineup-client/docs/components/CalendarCells/interfaces/CalendarCellProps.md b/lineup-client/docs/components/CalendarCells/interfaces/CalendarCellProps.md index f993ead..bb99694 100644 --- a/lineup-client/docs/components/CalendarCells/interfaces/CalendarCellProps.md +++ b/lineup-client/docs/components/CalendarCells/interfaces/CalendarCellProps.md @@ -6,7 +6,7 @@ # Interface: CalendarCellProps -Defined in: [components/CalendarCells.tsx:8](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L8) +Defined in: [components/CalendarCells.tsx:8](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L8) Props for the [ColoredCell](../functions/ColoredCell.md) and [FillableCell](../functions/FillableCell.md) components. @@ -16,7 +16,7 @@ Props for the [ColoredCell](../functions/ColoredCell.md) and [FillableCell](../f > **colors**: `object` -Defined in: [components/CalendarCells.tsx:34](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L34) +Defined in: [components/CalendarCells.tsx:34](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L34) Map of UTC timestamps to CSS colors. @@ -30,7 +30,7 @@ Map of UTC timestamps to CSS colors. > **date**: `Date` -Defined in: [components/CalendarCells.tsx:13](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L13) +Defined in: [components/CalendarCells.tsx:13](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L13) The day of the month (column). @@ -40,7 +40,7 @@ The day of the month (column). > **isEnablingCells**: `boolean` -Defined in: [components/CalendarCells.tsx:28](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L28) +Defined in: [components/CalendarCells.tsx:28](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L28) If the user is enabling or disabling cells. @@ -50,7 +50,7 @@ If the user is enabling or disabling cells. > **isPointerDown**: `boolean` -Defined in: [components/CalendarCells.tsx:22](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L22) +Defined in: [components/CalendarCells.tsx:22](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L22) If the user is holding mouse click/tap. @@ -60,7 +60,7 @@ If the user is holding mouse click/tap. > `optional` **selectedCells?**: `string`[] -Defined in: [components/CalendarCells.tsx:16](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L16) +Defined in: [components/CalendarCells.tsx:16](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L16) Array of UTC timestamps for which cells are shown as selected. @@ -70,7 +70,7 @@ Array of UTC timestamps for which cells are shown as selected. > **setIsEnablingCells**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> -Defined in: [components/CalendarCells.tsx:31](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L31) +Defined in: [components/CalendarCells.tsx:31](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L31) React state setter for [isEnablingCells](#isenablingcells). @@ -80,7 +80,7 @@ React state setter for [isEnablingCells](#isenablingcells). > **setIsPointerDown**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> -Defined in: [components/CalendarCells.tsx:25](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L25) +Defined in: [components/CalendarCells.tsx:25](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L25) React state setter to update if the user is holding mouse click/tap. @@ -90,7 +90,7 @@ React state setter to update if the user is holding mouse click/tap. > `optional` **setSelectedCells?**: `Dispatch`\<`SetStateAction`\<`string`[]\>\> -Defined in: [components/CalendarCells.tsx:19](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L19) +Defined in: [components/CalendarCells.tsx:19](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L19) React state setter for [selectedCells](#selectedcells). @@ -100,7 +100,7 @@ React state setter for [selectedCells](#selectedcells). > **text**: `object` -Defined in: [components/CalendarCells.tsx:37](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L37) +Defined in: [components/CalendarCells.tsx:37](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L37) Map of UTC timestamps to text displayed on the cell. @@ -114,6 +114,6 @@ Map of UTC timestamps to text displayed on the cell. > **time**: [`Time`](../../../types/type-aliases/Time.md) -Defined in: [components/CalendarCells.tsx:10](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CalendarCells.tsx#L10) +Defined in: [components/CalendarCells.tsx:10](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CalendarCells.tsx#L10) The start time (row). diff --git a/lineup-client/docs/components/CopyableLink/functions/default.md b/lineup-client/docs/components/CopyableLink/functions/default.md index c7e62e0..5cf7b3a 100644 --- a/lineup-client/docs/components/CopyableLink/functions/default.md +++ b/lineup-client/docs/components/CopyableLink/functions/default.md @@ -8,7 +8,7 @@ > **default**(`props`): `Element` -Defined in: [components/CopyableLink.tsx:22](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CopyableLink.tsx#L22) +Defined in: [components/CopyableLink.tsx:22](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CopyableLink.tsx#L22) A link that appears as text and can be clicked to copy the text to a user's clipboard. diff --git a/lineup-client/docs/components/CopyableLink/interfaces/CopyableLinkProps.md b/lineup-client/docs/components/CopyableLink/interfaces/CopyableLinkProps.md index c095910..f548a0a 100644 --- a/lineup-client/docs/components/CopyableLink/interfaces/CopyableLinkProps.md +++ b/lineup-client/docs/components/CopyableLink/interfaces/CopyableLinkProps.md @@ -6,7 +6,7 @@ # Interface: CopyableLinkProps -Defined in: [components/CopyableLink.tsx:6](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CopyableLink.tsx#L6) +Defined in: [components/CopyableLink.tsx:6](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CopyableLink.tsx#L6) Props for the [CopyableLink](../functions/default.md) component. @@ -16,7 +16,7 @@ Props for the [CopyableLink](../functions/default.md) component. > `optional` **display?**: `string` -Defined in: [components/CopyableLink.tsx:14](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CopyableLink.tsx#L14) +Defined in: [components/CopyableLink.tsx:14](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CopyableLink.tsx#L14) The string to display on the page that the user clicks to copy. @@ -30,6 +30,6 @@ The string to display on the page that the user clicks to copy. > **url**: `string` -Defined in: [components/CopyableLink.tsx:8](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/CopyableLink.tsx#L8) +Defined in: [components/CopyableLink.tsx:8](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/CopyableLink.tsx#L8) The url to be copied to clipboard. diff --git a/lineup-client/docs/components/MousePopup/functions/MousePopup.md b/lineup-client/docs/components/MousePopup/functions/MousePopup.md index 79af0f4..afea515 100644 --- a/lineup-client/docs/components/MousePopup/functions/MousePopup.md +++ b/lineup-client/docs/components/MousePopup/functions/MousePopup.md @@ -8,7 +8,7 @@ > **MousePopup**(`props`): `Element` \| `null` -Defined in: [components/MousePopup.tsx:27](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L27) +Defined in: [components/MousePopup.tsx:27](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L27) A customizeable popup that will follow the mouse position. diff --git a/lineup-client/docs/components/MousePopup/interfaces/MousePopupProps.md b/lineup-client/docs/components/MousePopup/interfaces/MousePopupProps.md index 68abafe..42157f1 100644 --- a/lineup-client/docs/components/MousePopup/interfaces/MousePopupProps.md +++ b/lineup-client/docs/components/MousePopup/interfaces/MousePopupProps.md @@ -6,7 +6,7 @@ # Interface: MousePopupProps -Defined in: [components/MousePopup.tsx:7](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L7) +Defined in: [components/MousePopup.tsx:7](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L7) Props for the [MousePopup](../functions/MousePopup.md) component. @@ -16,7 +16,7 @@ Props for the [MousePopup](../functions/MousePopup.md) component. > **children**: `ReactNode` -Defined in: [components/MousePopup.tsx:19](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L19) +Defined in: [components/MousePopup.tsx:19](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L19) The component to render inside of the popup. @@ -26,7 +26,7 @@ The component to render inside of the popup. > `optional` **fadeDuration?**: `number` -Defined in: [components/MousePopup.tsx:16](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L16) +Defined in: [components/MousePopup.tsx:16](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L16) How long it takes the popup to fade in and out when [isOpen](#isopen) changes. @@ -36,7 +36,7 @@ How long it takes the popup to fade in and out when [isOpen](#isopen) changes. > `optional` **height?**: `number` -Defined in: [components/MousePopup.tsx:13](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L13) +Defined in: [components/MousePopup.tsx:13](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L13) --- @@ -44,7 +44,7 @@ Defined in: [components/MousePopup.tsx:13](https://github.com/rhyderswen/LineUp/ > **isOpen**: `boolean` -Defined in: [components/MousePopup.tsx:9](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L9) +Defined in: [components/MousePopup.tsx:9](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L9) If the popup is visible or not. @@ -54,4 +54,4 @@ If the popup is visible or not. > `optional` **width?**: `number` -Defined in: [components/MousePopup.tsx:11](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/MousePopup.tsx#L11) +Defined in: [components/MousePopup.tsx:11](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/MousePopup.tsx#L11) diff --git a/lineup-client/docs/components/Table/functions/default.md b/lineup-client/docs/components/Table/functions/default.md index e875e5b..cf26287 100644 --- a/lineup-client/docs/components/Table/functions/default.md +++ b/lineup-client/docs/components/Table/functions/default.md @@ -8,7 +8,7 @@ > **default**\<`T`\>(`props`): `Element` -Defined in: [components/Table.tsx:31](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L31) +Defined in: [components/Table.tsx:31](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L31) A customizable table that renders row data into a common format. diff --git a/lineup-client/docs/components/Table/interfaces/TableProps.md b/lineup-client/docs/components/Table/interfaces/TableProps.md index ab5decd..77cbd54 100644 --- a/lineup-client/docs/components/Table/interfaces/TableProps.md +++ b/lineup-client/docs/components/Table/interfaces/TableProps.md @@ -6,7 +6,7 @@ # Interface: TableProps\ -Defined in: [components/Table.tsx:7](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L7) +Defined in: [components/Table.tsx:7](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L7) Props for the [Table](../functions/default.md) component. @@ -24,7 +24,7 @@ The type of the data for a single row. > `optional` **columnWidths?**: `string`[] -Defined in: [components/Table.tsx:22](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L22) +Defined in: [components/Table.tsx:22](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L22) A list of CSS width values. @@ -46,7 +46,7 @@ Equal widths > **data**: `T`[] -Defined in: [components/Table.tsx:12](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L12) +Defined in: [components/Table.tsx:12](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L12) The data to be rendered inside each row. @@ -56,7 +56,7 @@ The data to be rendered inside each row. > **headers**: `string`[] -Defined in: [components/Table.tsx:9](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L9) +Defined in: [components/Table.tsx:9](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L9) The name to display at the top of each column. @@ -66,7 +66,7 @@ The name to display at the top of each column. > **renderRow**: (`item`) => `ReactNode` -Defined in: [components/Table.tsx:15](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Table.tsx#L15) +Defined in: [components/Table.tsx:15](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Table.tsx#L15) The function to render a single row. Will be called for each row. diff --git a/lineup-client/docs/components/Topbar/functions/default.md b/lineup-client/docs/components/Topbar/functions/default.md index ff29eb3..d724711 100644 --- a/lineup-client/docs/components/Topbar/functions/default.md +++ b/lineup-client/docs/components/Topbar/functions/default.md @@ -8,7 +8,7 @@ > **default**(`props`): `Element` -Defined in: [components/Topbar.tsx:20](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Topbar.tsx#L20) +Defined in: [components/Topbar.tsx:20](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Topbar.tsx#L20) A common component that will appear on every page, complete with helpful links that are needed on all pages. diff --git a/lineup-client/docs/components/Topbar/interfaces/TopbarProps.md b/lineup-client/docs/components/Topbar/interfaces/TopbarProps.md index 6f8e568..fb36aec 100644 --- a/lineup-client/docs/components/Topbar/interfaces/TopbarProps.md +++ b/lineup-client/docs/components/Topbar/interfaces/TopbarProps.md @@ -6,7 +6,7 @@ # Interface: TopbarProps -Defined in: [components/Topbar.tsx:10](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Topbar.tsx#L10) +Defined in: [components/Topbar.tsx:10](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Topbar.tsx#L10) Props for the [Topbar](../functions/default.md) component. @@ -16,6 +16,6 @@ Props for the [Topbar](../functions/default.md) component. > **children**: `ReactNode` -Defined in: [components/Topbar.tsx:12](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/components/Topbar.tsx#L12) +Defined in: [components/Topbar.tsx:12](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/components/Topbar.tsx#L12) The main interactive portion of the app (anything that's beneath the topbar). diff --git a/lineup-client/docs/index.md b/lineup-client/docs/index.md index d249035..93051ec 100644 --- a/lineup-client/docs/index.md +++ b/lineup-client/docs/index.md @@ -8,3 +8,5 @@ The Frontend for LineUp uses React, TypeScript, Vite, and pnpm. The frontend wil - `pnpm i` - `pnpm test` + +For documentation on the individual modules, please go to [Modules](/client-docs/modules.html). diff --git a/lineup-client/docs/pages/Availability/functions/default.md b/lineup-client/docs/pages/Availability/functions/default.md index d3b2f62..1117dd9 100644 --- a/lineup-client/docs/pages/Availability/functions/default.md +++ b/lineup-client/docs/pages/Availability/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/Availability.tsx:12](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/Availability.tsx#L12) +Defined in: [pages/Availability.tsx:12](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/Availability.tsx#L12) The page displayed when a user wishes to input and submit their availability to a schedule. Switches over to displaying the generated schedule once generated. diff --git a/lineup-client/docs/pages/EditAvailability/functions/default.md b/lineup-client/docs/pages/EditAvailability/functions/default.md index 585a0d2..58a053b 100644 --- a/lineup-client/docs/pages/EditAvailability/functions/default.md +++ b/lineup-client/docs/pages/EditAvailability/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/EditAvailability.tsx:11](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/EditAvailability.tsx#L11) +Defined in: [pages/EditAvailability.tsx:11](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/EditAvailability.tsx#L11) The page displayed when a user clicks on the edit link sent to their email. Allows them to update their availability selections if the schedule has not yet been generated. diff --git a/lineup-client/docs/pages/Error/functions/default.md b/lineup-client/docs/pages/Error/functions/default.md index d2a7c28..a0ac25b 100644 --- a/lineup-client/docs/pages/Error/functions/default.md +++ b/lineup-client/docs/pages/Error/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/Error.tsx:6](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/Error.tsx#L6) +Defined in: [pages/Error.tsx:6](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/Error.tsx#L6) The page rendered if React recieves any error that causes the previous page to crash. diff --git a/lineup-client/docs/pages/Home/functions/default.md b/lineup-client/docs/pages/Home/functions/default.md index f34a9f0..f82735e 100644 --- a/lineup-client/docs/pages/Home/functions/default.md +++ b/lineup-client/docs/pages/Home/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/Home.tsx:6](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/Home.tsx#L6) +Defined in: [pages/Home.tsx:6](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/Home.tsx#L6) A wrapper for the home page. Displays [LoggedOutHome](../../LoggedOutHome/functions/default.md) or [LoggedInHome](../../LoggedInHome/functions/default.md) depending on the authentication status. diff --git a/lineup-client/docs/pages/LoggedInHome/functions/default.md b/lineup-client/docs/pages/LoggedInHome/functions/default.md index eb23a68..94edf23 100644 --- a/lineup-client/docs/pages/LoggedInHome/functions/default.md +++ b/lineup-client/docs/pages/LoggedInHome/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/LoggedInHome.tsx:21](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/LoggedInHome.tsx#L21) +Defined in: [pages/LoggedInHome.tsx:21](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/LoggedInHome.tsx#L21) The default page displayed when a user is logged in. Shows a user their list of schedules and allows for easy navigation to other administritive parts of the website. diff --git a/lineup-client/docs/pages/LoggedOutHome/functions/default.md b/lineup-client/docs/pages/LoggedOutHome/functions/default.md index 1d9d8ac..822d795 100644 --- a/lineup-client/docs/pages/LoggedOutHome/functions/default.md +++ b/lineup-client/docs/pages/LoggedOutHome/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/LoggedOutHome.tsx:4](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/LoggedOutHome.tsx#L4) +Defined in: [pages/LoggedOutHome.tsx:4](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/LoggedOutHome.tsx#L4) The default page displayed when a user is _not_ logged in. Displays very basic information about how to log in. diff --git a/lineup-client/docs/pages/NewSchedule/functions/default.md b/lineup-client/docs/pages/NewSchedule/functions/default.md index afaba0c..e056b66 100644 --- a/lineup-client/docs/pages/NewSchedule/functions/default.md +++ b/lineup-client/docs/pages/NewSchedule/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/NewSchedule.tsx:31](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/NewSchedule.tsx#L31) +Defined in: [pages/NewSchedule.tsx:31](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/NewSchedule.tsx#L31) The page displayed when a manager wishes to create a new schedule. Allows a manager to input their schedule settings and submit a backend request to create the schedule. diff --git a/lineup-client/docs/pages/ViewEditSchedule/functions/default.md b/lineup-client/docs/pages/ViewEditSchedule/functions/default.md index 0bd0491..6d826ef 100644 --- a/lineup-client/docs/pages/ViewEditSchedule/functions/default.md +++ b/lineup-client/docs/pages/ViewEditSchedule/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `Element` -Defined in: [pages/ViewEditSchedule.tsx:28](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/pages/ViewEditSchedule.tsx#L28) +Defined in: [pages/ViewEditSchedule.tsx:28](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/pages/ViewEditSchedule.tsx#L28) The page displayed when a manager wishes to view responses or edit one of their previously-created schedules. Allows a manager to see what users are available at what times and submit updates to their chosen calendar parameters. diff --git a/lineup-client/docs/types/type-aliases/Time.md b/lineup-client/docs/types/type-aliases/Time.md index 3262d57..d22f656 100644 --- a/lineup-client/docs/types/type-aliases/Time.md +++ b/lineup-client/docs/types/type-aliases/Time.md @@ -8,7 +8,7 @@ > **Time** = `object` -Defined in: [types.ts:10](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L10) +Defined in: [types.ts:10](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L10) ## Properties @@ -16,7 +16,7 @@ Defined in: [types.ts:10](https://github.com/rhyderswen/LineUp/blob/b2755005f655 > **hour**: [`ValidHours`](ValidHours.md) -Defined in: [types.ts:11](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L11) +Defined in: [types.ts:11](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L11) --- @@ -24,4 +24,4 @@ Defined in: [types.ts:11](https://github.com/rhyderswen/LineUp/blob/b2755005f655 > **minute**: [`ValidMinutes`](ValidMinutes.md) -Defined in: [types.ts:12](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L12) diff --git a/lineup-client/docs/types/type-aliases/TimeRange.md b/lineup-client/docs/types/type-aliases/TimeRange.md index ad7d446..88a76ef 100644 --- a/lineup-client/docs/types/type-aliases/TimeRange.md +++ b/lineup-client/docs/types/type-aliases/TimeRange.md @@ -8,7 +8,7 @@ > **TimeRange** = `object` -Defined in: [types.ts:15](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L15) +Defined in: [types.ts:15](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L15) ## Properties @@ -16,7 +16,7 @@ Defined in: [types.ts:15](https://github.com/rhyderswen/LineUp/blob/b2755005f655 > **end**: [`Time`](Time.md) -Defined in: [types.ts:17](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L17) +Defined in: [types.ts:17](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L17) --- @@ -24,4 +24,4 @@ Defined in: [types.ts:17](https://github.com/rhyderswen/LineUp/blob/b2755005f655 > **start**: [`Time`](Time.md) -Defined in: [types.ts:16](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L16) diff --git a/lineup-client/docs/types/type-aliases/ValidHours.md b/lineup-client/docs/types/type-aliases/ValidHours.md index 9139fb5..5e7e4b6 100644 --- a/lineup-client/docs/types/type-aliases/ValidHours.md +++ b/lineup-client/docs/types/type-aliases/ValidHours.md @@ -8,4 +8,4 @@ > **ValidHours** = `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` \| `7` \| `8` \| `9` \| `10` \| `11` \| `12` \| `13` \| `14` \| `15` \| `16` \| `17` \| `18` \| `19` \| `20` \| `21` \| `22` \| `23` -Defined in: [types.ts:8](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L8) +Defined in: [types.ts:8](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L8) diff --git a/lineup-client/docs/types/type-aliases/ValidMinutes.md b/lineup-client/docs/types/type-aliases/ValidMinutes.md index 1a2e33f..418f161 100644 --- a/lineup-client/docs/types/type-aliases/ValidMinutes.md +++ b/lineup-client/docs/types/type-aliases/ValidMinutes.md @@ -8,4 +8,4 @@ > **ValidMinutes** = `0` \| `15` \| `20` \| `30` \| `40` \| `45` \| `60` -Defined in: [types.ts:5](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L5) +Defined in: [types.ts:5](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L5) diff --git a/lineup-client/docs/types/type-aliases/Weekday.md b/lineup-client/docs/types/type-aliases/Weekday.md index 6c1667c..31702cb 100644 --- a/lineup-client/docs/types/type-aliases/Weekday.md +++ b/lineup-client/docs/types/type-aliases/Weekday.md @@ -8,4 +8,4 @@ > **Weekday** = _typeof_ [`WEEKDAYS`](../variables/WEEKDAYS.md)\[`number`\] -Defined in: [types.ts:3](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L3) +Defined in: [types.ts:3](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L3) diff --git a/lineup-client/docs/types/variables/WEEKDAYS.md b/lineup-client/docs/types/variables/WEEKDAYS.md index e0985dc..91e52d7 100644 --- a/lineup-client/docs/types/variables/WEEKDAYS.md +++ b/lineup-client/docs/types/variables/WEEKDAYS.md @@ -8,4 +8,4 @@ > `const` **WEEKDAYS**: readonly \[`"Sunday"`, `"Monday"`, `"Tuesday"`, `"Wednesday"`, `"Thursday"`, `"Friday"`, `"Saturday"`\] -Defined in: [types.ts:1](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/types.ts#L1) +Defined in: [types.ts:1](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/types.ts#L1) diff --git a/lineup-client/docs/utils/api/auth-token/functions/getToken.md b/lineup-client/docs/utils/api/auth-token/functions/getToken.md index fd645b1..559aa66 100644 --- a/lineup-client/docs/utils/api/auth-token/functions/getToken.md +++ b/lineup-client/docs/utils/api/auth-token/functions/getToken.md @@ -8,7 +8,7 @@ > **getToken**(): `Promise`\<`string` \| `null`\> -Defined in: [utils/api/auth-token.ts:24](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L24) +Defined in: [utils/api/auth-token.ts:24](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L24) Returns a token once [registerGetToken](registerGetToken.md) has been successfully called. diff --git a/lineup-client/docs/utils/api/auth-token/functions/logout.md b/lineup-client/docs/utils/api/auth-token/functions/logout.md index 330b02d..60bdbbd 100644 --- a/lineup-client/docs/utils/api/auth-token/functions/logout.md +++ b/lineup-client/docs/utils/api/auth-token/functions/logout.md @@ -8,7 +8,7 @@ > **logout**(`options?`): `Promise`\<`void`\> -Defined in: [utils/api/auth-token.ts:46](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L46) +Defined in: [utils/api/auth-token.ts:46](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L46) Logs the user out once [registerLogout](registerLogout.md) has been successfully called. diff --git a/lineup-client/docs/utils/api/auth-token/functions/registerGetToken.md b/lineup-client/docs/utils/api/auth-token/functions/registerGetToken.md index 43a90ff..272012f 100644 --- a/lineup-client/docs/utils/api/auth-token/functions/registerGetToken.md +++ b/lineup-client/docs/utils/api/auth-token/functions/registerGetToken.md @@ -8,7 +8,7 @@ > **registerGetToken**(`fn`): `void` -Defined in: [utils/api/auth-token.ts:15](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L15) +Defined in: [utils/api/auth-token.ts:15](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L15) Register a [getAccessTokenSilently (auth0)](https://auth0.github.io/auth0-react/functions/useAuth0.html) function for use in loaders, which can't use hooks. diff --git a/lineup-client/docs/utils/api/auth-token/functions/registerLogout.md b/lineup-client/docs/utils/api/auth-token/functions/registerLogout.md index d082c9a..5f7d8c8 100644 --- a/lineup-client/docs/utils/api/auth-token/functions/registerLogout.md +++ b/lineup-client/docs/utils/api/auth-token/functions/registerLogout.md @@ -8,7 +8,7 @@ > **registerLogout**(`fn`): `void` -Defined in: [utils/api/auth-token.ts:39](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L39) +Defined in: [utils/api/auth-token.ts:39](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L39) Register a [logout (auth0)](https://auth0.github.io/auth0-react/functions/useAuth0.html) function for use in loaders, which can't use hooks. diff --git a/lineup-client/docs/utils/api/auth-token/type-aliases/GetTokenFn.md b/lineup-client/docs/utils/api/auth-token/type-aliases/GetTokenFn.md index cda09c1..43d6cbe 100644 --- a/lineup-client/docs/utils/api/auth-token/type-aliases/GetTokenFn.md +++ b/lineup-client/docs/utils/api/auth-token/type-aliases/GetTokenFn.md @@ -8,7 +8,7 @@ > **GetTokenFn** = () => `Promise`\<`string`\> -Defined in: [utils/api/auth-token.ts:2](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L2) +Defined in: [utils/api/auth-token.ts:2](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L2) The type of the function that gets a token. diff --git a/lineup-client/docs/utils/api/auth-token/type-aliases/LogoutFn.md b/lineup-client/docs/utils/api/auth-token/type-aliases/LogoutFn.md index aa87605..5804f46 100644 --- a/lineup-client/docs/utils/api/auth-token/type-aliases/LogoutFn.md +++ b/lineup-client/docs/utils/api/auth-token/type-aliases/LogoutFn.md @@ -8,7 +8,7 @@ > **LogoutFn** = (`options?`) => `Promise`\<`void`\> -Defined in: [utils/api/auth-token.ts:5](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/auth-token.ts#L5) +Defined in: [utils/api/auth-token.ts:5](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/auth-token.ts#L5) The type of the logout function. diff --git a/lineup-client/docs/utils/api/context/type-aliases/AuthContextValue.md b/lineup-client/docs/utils/api/context/type-aliases/AuthContextValue.md index d24f9c6..ca339a2 100644 --- a/lineup-client/docs/utils/api/context/type-aliases/AuthContextValue.md +++ b/lineup-client/docs/utils/api/context/type-aliases/AuthContextValue.md @@ -8,7 +8,7 @@ > **AuthContextValue** = `object` -Defined in: [utils/api/context.ts:5](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/context.ts#L5) +Defined in: [utils/api/context.ts:5](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/context.ts#L5) The functions to be available to all children of an [AuthProvider](../../provider/variables/AuthProvider.md). @@ -18,7 +18,7 @@ The functions to be available to all children of an [AuthProvider](../../provide > **fetchWithAuth**: (`path`, `init?`) => `Promise`\<`Response`\> -Defined in: [utils/api/context.ts:6](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/context.ts#L6) +Defined in: [utils/api/context.ts:6](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/context.ts#L6) #### Parameters diff --git a/lineup-client/docs/utils/api/context/variables/AuthContext.md b/lineup-client/docs/utils/api/context/variables/AuthContext.md index 6782241..3ab964b 100644 --- a/lineup-client/docs/utils/api/context/variables/AuthContext.md +++ b/lineup-client/docs/utils/api/context/variables/AuthContext.md @@ -8,6 +8,6 @@ > `const` **AuthContext**: `Context`\<[`AuthContextValue`](../type-aliases/AuthContextValue.md) \| `undefined`\> -Defined in: [utils/api/context.ts:10](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/context.ts#L10) +Defined in: [utils/api/context.ts:10](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/context.ts#L10) Creates a context for authentication, needed in a non-component file to be referenced anywhere. diff --git a/lineup-client/docs/utils/api/context/variables/queryClient.md b/lineup-client/docs/utils/api/context/variables/queryClient.md index 70bea90..60a4c95 100644 --- a/lineup-client/docs/utils/api/context/variables/queryClient.md +++ b/lineup-client/docs/utils/api/context/variables/queryClient.md @@ -8,6 +8,6 @@ > `const` **queryClient**: `QueryClient` -Defined in: [utils/api/context.ts:13](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/context.ts#L13) +Defined in: [utils/api/context.ts:13](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/context.ts#L13) The TanStack Query Client, which manages all caching. diff --git a/lineup-client/docs/utils/api/provider/variables/AuthProvider.md b/lineup-client/docs/utils/api/provider/variables/AuthProvider.md index 41db54d..f5b693e 100644 --- a/lineup-client/docs/utils/api/provider/variables/AuthProvider.md +++ b/lineup-client/docs/utils/api/provider/variables/AuthProvider.md @@ -8,7 +8,7 @@ > `const` **AuthProvider**: `React.FC`\<\{ `children`: `React.ReactNode`; \}\> -Defined in: [utils/api/provider.tsx:20](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/provider.tsx#L20) +Defined in: [utils/api/provider.tsx:20](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/provider.tsx#L20) The AuthProvider, which provides secure and common functionality for all authenticated functions. diff --git a/lineup-client/docs/utils/api/useApi/functions/useApi.md b/lineup-client/docs/utils/api/useApi/functions/useApi.md index ac402a0..2148916 100644 --- a/lineup-client/docs/utils/api/useApi/functions/useApi.md +++ b/lineup-client/docs/utils/api/useApi/functions/useApi.md @@ -8,7 +8,7 @@ > **useApi**(): [`AuthContextValue`](../../context/type-aliases/AuthContextValue.md) -Defined in: [utils/api/useApi.ts:7](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/api/useApi.ts#L7) +Defined in: [utils/api/useApi.ts:7](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/api/useApi.ts#L7) A hook that allows a function to call authenticated functions. diff --git a/lineup-client/docs/utils/db/functions/addToasts.md b/lineup-client/docs/utils/db/functions/addToasts.md index 6ef1080..9d75ee7 100644 --- a/lineup-client/docs/utils/db/functions/addToasts.md +++ b/lineup-client/docs/utils/db/functions/addToasts.md @@ -8,7 +8,7 @@ > **addToasts**(`promise`, `loadingMessage?`, `successMessage?`): `void` -Defined in: [utils/db.tsx:12](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/db.tsx#L12) +Defined in: [utils/db.tsx:12](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/db.tsx#L12) Adds toasts to asynchronous functions to give user's updates on their API queries. diff --git a/lineup-client/docs/utils/db/functions/authorizedLoaderQuery.md b/lineup-client/docs/utils/db/functions/authorizedLoaderQuery.md index c96bd56..b8c3e1c 100644 --- a/lineup-client/docs/utils/db/functions/authorizedLoaderQuery.md +++ b/lineup-client/docs/utils/db/functions/authorizedLoaderQuery.md @@ -8,7 +8,7 @@ > **authorizedLoaderQuery**(`url`, `param`): `object` -Defined in: [utils/db.tsx:75](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/db.tsx#L75) +Defined in: [utils/db.tsx:75](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/db.tsx#L75) A [React Router Loader](https://reactrouter.com/start/framework/data-loading) function for checking if a dynamic route exists and getting that page's associated data. Used for restrcted pages that require a user to be logged in (ViewEditSchedule). diff --git a/lineup-client/docs/utils/db/functions/unauthorizedLoaderQuery.md b/lineup-client/docs/utils/db/functions/unauthorizedLoaderQuery.md index 57f9809..fb69208 100644 --- a/lineup-client/docs/utils/db/functions/unauthorizedLoaderQuery.md +++ b/lineup-client/docs/utils/db/functions/unauthorizedLoaderQuery.md @@ -8,7 +8,7 @@ > **unauthorizedLoaderQuery**(`url`, `param`): `object` -Defined in: [utils/db.tsx:28](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/db.tsx#L28) +Defined in: [utils/db.tsx:28](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/db.tsx#L28) A [React Router Loader](https://reactrouter.com/start/framework/data-loading) function for checking if a dynamic route exists and getting that page's associated data. Used for pages that users don't need to log in for (Availability and EditAvailability pages). diff --git a/lineup-client/docs/utils/time/functions/addMinutesToTime.md b/lineup-client/docs/utils/time/functions/addMinutesToTime.md index 5b58a1e..9e94bd5 100644 --- a/lineup-client/docs/utils/time/functions/addMinutesToTime.md +++ b/lineup-client/docs/utils/time/functions/addMinutesToTime.md @@ -8,7 +8,7 @@ > **addMinutesToTime**(`time`, `minutes`): [`Time`](../../../types/type-aliases/Time.md) -Defined in: [utils/time.ts:13](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L13) +Defined in: [utils/time.ts:13](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L13) Adds a given amount of minutes to a [Time](../../../types/type-aliases/Time.md) object. diff --git a/lineup-client/docs/utils/time/functions/addTimeToDate.md b/lineup-client/docs/utils/time/functions/addTimeToDate.md index 642c45f..d87fbfe 100644 --- a/lineup-client/docs/utils/time/functions/addTimeToDate.md +++ b/lineup-client/docs/utils/time/functions/addTimeToDate.md @@ -8,7 +8,7 @@ > **addTimeToDate**(`date`, `time`): `Date` -Defined in: [utils/time.ts:147](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L147) +Defined in: [utils/time.ts:147](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L147) Combines a Time object to a Date object, returning a new Date object with the specified day of the Date but the specified time of the Time object. diff --git a/lineup-client/docs/utils/time/functions/dayNumberToWeekday.md b/lineup-client/docs/utils/time/functions/dayNumberToWeekday.md index 956be66..867234e 100644 --- a/lineup-client/docs/utils/time/functions/dayNumberToWeekday.md +++ b/lineup-client/docs/utils/time/functions/dayNumberToWeekday.md @@ -8,7 +8,7 @@ > **dayNumberToWeekday**(`num`): `"Sunday"` \| `"Monday"` \| `"Tuesday"` \| `"Wednesday"` \| `"Thursday"` \| `"Friday"` \| `"Saturday"` -Defined in: [utils/time.ts:66](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L66) +Defined in: [utils/time.ts:66](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L66) Converts a number representing a day of the week (0-6) to the corresponding weekday string (`"Sunday"`-`"Saturday"`). diff --git a/lineup-client/docs/utils/time/functions/formatTime.md b/lineup-client/docs/utils/time/functions/formatTime.md index 7f833b0..caae65a 100644 --- a/lineup-client/docs/utils/time/functions/formatTime.md +++ b/lineup-client/docs/utils/time/functions/formatTime.md @@ -8,7 +8,7 @@ > **formatTime**(`time`): `string` -Defined in: [utils/time.ts:27](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L27) +Defined in: [utils/time.ts:27](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L27) Formats a [Time](../../../types/type-aliases/Time.md) object into 12H format with AM/PM. diff --git a/lineup-client/docs/utils/time/functions/formatTime24Hour.md b/lineup-client/docs/utils/time/functions/formatTime24Hour.md index b9103c0..e7209b7 100644 --- a/lineup-client/docs/utils/time/functions/formatTime24Hour.md +++ b/lineup-client/docs/utils/time/functions/formatTime24Hour.md @@ -8,7 +8,7 @@ > **formatTime24Hour**(`time`): `string` -Defined in: [utils/time.ts:98](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L98) +Defined in: [utils/time.ts:98](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L98) Formats a [Time](../../../types/type-aliases/Time.md) object into 24H format without AM/PM. diff --git a/lineup-client/docs/utils/time/functions/getTimeIncrementLabel.md b/lineup-client/docs/utils/time/functions/getTimeIncrementLabel.md index d0f2459..a708cf8 100644 --- a/lineup-client/docs/utils/time/functions/getTimeIncrementLabel.md +++ b/lineup-client/docs/utils/time/functions/getTimeIncrementLabel.md @@ -8,7 +8,7 @@ > **getTimeIncrementLabel**(`row`, `rangeStart`, `minutesPerCell`): `string` -Defined in: [utils/time.ts:51](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L51) +Defined in: [utils/time.ts:51](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L51) Generates the label to be shown on a given row of the calendar, based on the row, starting time, and minutes per cell. diff --git a/lineup-client/docs/utils/time/functions/getValidMinutesForInterval.md b/lineup-client/docs/utils/time/functions/getValidMinutesForInterval.md index 579787f..97b6b15 100644 --- a/lineup-client/docs/utils/time/functions/getValidMinutesForInterval.md +++ b/lineup-client/docs/utils/time/functions/getValidMinutesForInterval.md @@ -8,7 +8,7 @@ > **getValidMinutesForInterval**(`interval`): `number`[] -Defined in: [utils/time.ts:103](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L103) +Defined in: [utils/time.ts:103](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L103) Returns the valid minute values that can be chosen for the given cell size. diff --git a/lineup-client/docs/utils/time/functions/parseTimeString.md b/lineup-client/docs/utils/time/functions/parseTimeString.md index 9482865..7af7344 100644 --- a/lineup-client/docs/utils/time/functions/parseTimeString.md +++ b/lineup-client/docs/utils/time/functions/parseTimeString.md @@ -8,7 +8,7 @@ > **parseTimeString**(`time`): [`Time`](../../../types/type-aliases/Time.md) \| `null` -Defined in: [utils/time.ts:78](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L78) +Defined in: [utils/time.ts:78](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L78) Takes a time string in 24H format (e.g. `"23:59"`) and converts it to a [Time](../../../types/type-aliases/Time.md) object. diff --git a/lineup-client/docs/utils/time/functions/rangeIs24Hours.md b/lineup-client/docs/utils/time/functions/rangeIs24Hours.md index 305ea79..455236a 100644 --- a/lineup-client/docs/utils/time/functions/rangeIs24Hours.md +++ b/lineup-client/docs/utils/time/functions/rangeIs24Hours.md @@ -8,7 +8,7 @@ > **rangeIs24Hours**(`range`): `boolean` -Defined in: [utils/time.ts:134](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L134) +Defined in: [utils/time.ts:134](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L134) Returns true if the given [TimeRange](../../../types/type-aliases/TimeRange.md) represents a 24-hour range starting and ending at midnight; false otherwise. diff --git a/lineup-client/docs/utils/time/functions/standardizeDateAndTime.md b/lineup-client/docs/utils/time/functions/standardizeDateAndTime.md index 7907d61..ae578cb 100644 --- a/lineup-client/docs/utils/time/functions/standardizeDateAndTime.md +++ b/lineup-client/docs/utils/time/functions/standardizeDateAndTime.md @@ -8,7 +8,7 @@ > **standardizeDateAndTime**(`date`, `time`): `string` -Defined in: [utils/time.ts:157](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L157) +Defined in: [utils/time.ts:157](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L157) Takes a Date and Time and converts it to a standardized ISO string in UTC. diff --git a/lineup-client/docs/utils/time/functions/timesAreEqual.md b/lineup-client/docs/utils/time/functions/timesAreEqual.md index 3c186fd..d9b378b 100644 --- a/lineup-client/docs/utils/time/functions/timesAreEqual.md +++ b/lineup-client/docs/utils/time/functions/timesAreEqual.md @@ -8,7 +8,7 @@ > **timesAreEqual**(`time1`, `time2`): `boolean` -Defined in: [utils/time.ts:6](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L6) +Defined in: [utils/time.ts:6](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L6) Checks if two [Time](../../../types/type-aliases/Time.md) objects represent the same time. diff --git a/lineup-client/docs/utils/time/functions/toMinutes.md b/lineup-client/docs/utils/time/functions/toMinutes.md index 47269f1..f8ec96c 100644 --- a/lineup-client/docs/utils/time/functions/toMinutes.md +++ b/lineup-client/docs/utils/time/functions/toMinutes.md @@ -8,7 +8,7 @@ > **toMinutes**(`time`, `isEnd?`): `number` -Defined in: [utils/time.ts:125](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L125) +Defined in: [utils/time.ts:125](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L125) Converts a time to just how many minutes that time is past midnight. diff --git a/lineup-client/docs/utils/time/functions/weekdayToNum.md b/lineup-client/docs/utils/time/functions/weekdayToNum.md index b859dee..adf0ec6 100644 --- a/lineup-client/docs/utils/time/functions/weekdayToNum.md +++ b/lineup-client/docs/utils/time/functions/weekdayToNum.md @@ -8,7 +8,7 @@ > **weekdayToNum**(`weekday`): `number` -Defined in: [utils/time.ts:71](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/time.ts#L71) +Defined in: [utils/time.ts:71](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/time.ts#L71) Converts a weekday string (`"Sunday"`-`"Saturday"`) to the corresponding number (0-6). diff --git a/lineup-client/docs/utils/useMousePosition/functions/default.md b/lineup-client/docs/utils/useMousePosition/functions/default.md index aae56bb..f0e5f64 100644 --- a/lineup-client/docs/utils/useMousePosition/functions/default.md +++ b/lineup-client/docs/utils/useMousePosition/functions/default.md @@ -8,7 +8,7 @@ > **default**(): `object` -Defined in: [utils/useMousePosition.ts:7](https://github.com/rhyderswen/LineUp/blob/b2755005f655d50dd5f2fef681fc2f663505ff02/lineup-client/src/utils/useMousePosition.ts#L7) +Defined in: [utils/useMousePosition.ts:7](https://github.com/rhyderswen/LineUp/blob/e2f17bae616784da1758a5d11711773573512737/lineup-client/src/utils/useMousePosition.ts#L7) A hook for keeping track of the user's current mouse position.