Skip to content

Er/fix toc on frontend docs #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lndrysrvcs merged 17 commits into from
Apr 30, 2026
Merged

Er/fix toc on frontend docs #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
0007f1e
add combined docfx and client docs
lndrysrvcs Apr 29, 2026
f805bb0
uhhh things
lndrysrvcs Apr 29, 2026
20699a9
add csharp docs
lndrysrvcs Apr 29, 2026
c6ed0b3
relocate this
lndrysrvcs Apr 29, 2026
3b62f67
build site via gh actions
lndrysrvcs Apr 29, 2026
53a85b5
remove api yml
lndrysrvcs Apr 29, 2026
510a48f
fix docs action
lndrysrvcs Apr 29, 2026
1adb645
new index
lndrysrvcs Apr 29, 2026
f66a698
add documentation for controllers
lndrysrvcs Apr 29, 2026
ceeb9d0
mmm documentation
lndrysrvcs Apr 29, 2026
4f67d81
nobody knows where a toolbar is
lndrysrvcs Apr 30, 2026
e2f17ba
clarify documentation links and add demo instance info
lndrysrvcs Apr 30, 2026
a1be538
fix frontend toc
lndrysrvcs Apr 30, 2026
b7114dd
add copied toc to gitignore
lndrysrvcs Apr 30, 2026
bdeae3f
Merge branch 'main' into er/fix-toc-on-frontend-docs
lndrysrvcs Apr 30, 2026
6ad57cd
evil rebase
lndrysrvcs Apr 30, 2026
786a0d0
Add links
rhyderswen Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,3 +213,4 @@ openapi-spec/
# docfx
api/
_site/
lineup-client/docs/toc.yml
8 changes: 6 additions & 2 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
- **[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).
0 lineup-client/docs/toc.yml → lineup-client/client-toc.yml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion lineup-client/docs/App/functions/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion lineup-client/docs/components/Calendar/functions/Calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
20 changes: 10 additions & 10 deletions lineup-client/docs/components/Calendar/interfaces/CalendarProps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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).

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion lineup-client/docs/components/CalendarCells/functions/ColoredCell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion lineup-client/docs/components/CalendarCells/functions/FillableCell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
22 changes: 11 additions & 11 deletions lineup-client/docs/components/CalendarCells/interfaces/CalendarCellProps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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).

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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).

Expand All @@ -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.

Expand All @@ -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).

Expand All @@ -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.

Expand All @@ -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).
2 changes: 1 addition & 1 deletion lineup-client/docs/components/CopyableLink/functions/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions lineup-client/docs/components/CopyableLink/interfaces/CopyableLinkProps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.
2 changes: 1 addition & 1 deletion lineup-client/docs/components/MousePopup/functions/MousePopup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions lineup-client/docs/components/MousePopup/interfaces/MousePopupProps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -36,15 +36,15 @@ 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)

---

### isOpen

> **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.

Expand All @@ -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)
2 changes: 1 addition & 1 deletion lineup-client/docs/components/Table/functions/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading
Loading