diff --git a/docs/app/(access)/account/page/functions/default.md b/docs/app/(access)/account/page/functions/default.md new file mode 100644 index 0000000..bf33a87 --- /dev/null +++ b/docs/app/(access)/account/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(access)/account/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(access)/account/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/account/page.tsx#L3) diff --git a/docs/app/(access)/forgot-password/page/functions/default.md b/docs/app/(access)/forgot-password/page/functions/default.md new file mode 100644 index 0000000..522a7bb --- /dev/null +++ b/docs/app/(access)/forgot-password/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(access)/forgot-password/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(access)/forgot-password/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/forgot-password/page.tsx#L3) diff --git a/docs/app/(access)/login/page/functions/default.md b/docs/app/(access)/login/page/functions/default.md new file mode 100644 index 0000000..9658b7d --- /dev/null +++ b/docs/app/(access)/login/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(access)/login/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(access)/login/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/login/page.tsx#L3) diff --git a/docs/app/(access)/register/page/functions/default.md b/docs/app/(access)/register/page/functions/default.md new file mode 100644 index 0000000..cf053bb --- /dev/null +++ b/docs/app/(access)/register/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(access)/register/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(access)/register/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/register/page.tsx#L3) diff --git a/docs/app/(access)/reset-password/page/functions/default.md b/docs/app/(access)/reset-password/page/functions/default.md new file mode 100644 index 0000000..ae5a416 --- /dev/null +++ b/docs/app/(access)/reset-password/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(access)/reset-password/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(access)/reset-password/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/reset-password/page.tsx#L3) diff --git a/docs/app/(entry)/index/page/functions/default.md b/docs/app/(entry)/index/page/functions/default.md new file mode 100644 index 0000000..4cf816e --- /dev/null +++ b/docs/app/(entry)/index/page/functions/default.md @@ -0,0 +1,31 @@ +[**the-cdj-ui**](../../../../../README.md) + +*** + +[the-cdj-ui](../../../../../README.md) / [app/(entry)/index/page](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/app/(entry)/index/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(entry)/index/page.tsx#L3) diff --git a/docs/app/layout/functions/default.md b/docs/app/layout/functions/default.md new file mode 100644 index 0000000..a8dbb4e --- /dev/null +++ b/docs/app/layout/functions/default.md @@ -0,0 +1,25 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [app/layout](../README.md) / default + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +## Parameters + +### \_\_namedParameters + +#### children + +`ReactNode` + +## Returns + +`Element` + +## Defined in + +[src/app/layout.tsx:10](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/layout.tsx#L10) diff --git a/docs/app/not-found/functions/NotFoundContent.md b/docs/app/not-found/functions/NotFoundContent.md new file mode 100644 index 0000000..aaa9027 --- /dev/null +++ b/docs/app/not-found/functions/NotFoundContent.md @@ -0,0 +1,17 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [app/not-found](../README.md) / NotFoundContent + +# Function: NotFoundContent() + +> **NotFoundContent**(): `Element` + +## Returns + +`Element` + +## Defined in + +[src/app/not-found.tsx:9](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/not-found.tsx#L9) diff --git a/docs/app/not-found/variables/default.md b/docs/app/not-found/variables/default.md new file mode 100644 index 0000000..13683f2 --- /dev/null +++ b/docs/app/not-found/variables/default.md @@ -0,0 +1,13 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [app/not-found](../README.md) / default + +# Variable: default + +> `const` **default**: `ComponentType`\<\{\}\> + +## Defined in + +[src/app/not-found.tsx:80](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/not-found.tsx#L80) diff --git a/docs/Components/default.md b/docs/app/page/functions/default.md similarity index 53% rename from docs/Components/default.md rename to docs/app/page/functions/default.md index c350191..f336fa5 100644 --- a/docs/Components/default.md +++ b/docs/app/page/functions/default.md @@ -1,8 +1,8 @@ -[**the-cdj-ui**](../README.md) +[**the-cdj-ui**](../../../README.md) *** -[the-cdj-ui](../README.md) / default +[the-cdj-ui](../../../README.md) / [app/page](../README.md) / default # Function: default() @@ -18,4 +18,4 @@ application. ## Defined in -[page.tsx:8](https://github.com/hiyaryan/the-cdj-ui/blob/b8e1b6af9ddc33969bbe4132b67de35ad0c004db/src/app/page.tsx#L8) +[src/app/page.tsx:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/page.tsx#L8) diff --git a/docs/components/atoms/Button/functions/default.md b/docs/components/atoms/Button/functions/default.md new file mode 100644 index 0000000..2db8910 --- /dev/null +++ b/docs/components/atoms/Button/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Button](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`ButtonProps`](../../../../types/Button.types/interfaces/ButtonProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Button.tsx:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Button.tsx#L7) diff --git a/docs/components/atoms/Checkbox/functions/default.md b/docs/components/atoms/Checkbox/functions/default.md new file mode 100644 index 0000000..f249126 --- /dev/null +++ b/docs/components/atoms/Checkbox/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Checkbox](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`CheckboxProps`](../../../../types/Checkbox.types/interfaces/CheckboxProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Checkbox.tsx:6](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Checkbox.tsx#L6) diff --git a/docs/components/atoms/Input/functions/default.md b/docs/components/atoms/Input/functions/default.md new file mode 100644 index 0000000..f97577f --- /dev/null +++ b/docs/components/atoms/Input/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Input](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`InputProps`](../../../../types/Input.types/interfaces/InputProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Input.tsx:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Input.tsx#L7) diff --git a/docs/components/atoms/Link/functions/default.md b/docs/components/atoms/Link/functions/default.md new file mode 100644 index 0000000..17539af --- /dev/null +++ b/docs/components/atoms/Link/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Link](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`LinkProps`](../../../../types/Link.types/interfaces/LinkProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Link.tsx:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Link.tsx#L8) diff --git a/docs/components/atoms/Switch/functions/default.md b/docs/components/atoms/Switch/functions/default.md new file mode 100644 index 0000000..c7c7cf9 --- /dev/null +++ b/docs/components/atoms/Switch/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Switch](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`SwitchProps`](../../../../types/Switch.types/interfaces/SwitchProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Switch.tsx:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Switch.tsx#L7) diff --git a/docs/components/atoms/Text/functions/default.md b/docs/components/atoms/Text/functions/default.md new file mode 100644 index 0000000..e4f34a2 --- /dev/null +++ b/docs/components/atoms/Text/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../../README.md) + +*** + +[the-cdj-ui](../../../../README.md) / [components/atoms/Text](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`TextProps`](../../../../types/Text.types/interfaces/TextProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/components/atoms/Text.tsx:5](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Text.tsx#L5) diff --git a/docs/hooks/apiRequest/functions/apiRequest.md b/docs/hooks/apiRequest/functions/apiRequest.md new file mode 100644 index 0000000..f6ab673 --- /dev/null +++ b/docs/hooks/apiRequest/functions/apiRequest.md @@ -0,0 +1,56 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [hooks/apiRequest](../README.md) / apiRequest + +# Function: apiRequest() + +> **apiRequest**\<`T`\>(`url`, `options`?): `Promise`\<`T`\> + +Makes an API request to the specified URL with the given options. + +## Type Parameters + +• **T** + +## Parameters + +### url + +`string` + +The endpoint to call, relative to `API_BASE_URL`. + +### options? + +[`ApiOptions`](../interfaces/ApiOptions.md) = `DEFAULT_OPTIONS` + +The options to use for the +request. + +## Returns + +`Promise`\<`T`\> + +A promise that resolves to the response data as a +generic type `T`. + +## Throws + +Throws an error if the network response is not OK or if the +request fails. The error contains the response body as a JSON string. + +## Example + +```ts +const options: ApiOptions = { + method: 'POST', +}; + +const response = await apiRequest('/test-endpoint', options); +``` + +## Defined in + +[src/hooks/apiRequest.ts:47](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/hooks/apiRequest.ts#L47) diff --git a/docs/hooks/apiRequest/interfaces/ApiOptions.md b/docs/hooks/apiRequest/interfaces/ApiOptions.md new file mode 100644 index 0000000..ec90e57 --- /dev/null +++ b/docs/hooks/apiRequest/interfaces/ApiOptions.md @@ -0,0 +1,61 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [hooks/apiRequest](../README.md) / ApiOptions + +# Interface: ApiOptions + +Options for configuring an API request. + +## Properties + +### body? + +> `optional` **body**: `Record`\<`string`, `unknown`\> + +The request body to send with +the request (e.g., JSON data). + +#### Defined in + +[src/hooks/apiRequest.ts:25](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/hooks/apiRequest.ts#L25) + +*** + +### credentials? + +> `optional` **credentials**: `RequestCredentials` + +The credentials policy for +the request (e.g., 'include', 'same-origin', 'omit'). + +#### Defined in + +[src/hooks/apiRequest.ts:27](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/hooks/apiRequest.ts#L27) + +*** + +### headers + +> **headers**: `Record`\<`string`, `string`\> + +Headers to include in the +request (e.g., 'Content-Type', 'Authorization'). + +#### Defined in + +[src/hooks/apiRequest.ts:26](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/hooks/apiRequest.ts#L26) + +*** + +### method + +> **method**: `Method` + +The HTTP method to use for the request (e.g., +'GET', 'POST', 'PUT', 'DELETE'). + +#### Defined in + +[src/hooks/apiRequest.ts:24](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/hooks/apiRequest.ts#L24) diff --git a/docs/theme/ThemeContext/functions/ThemeProvider.md b/docs/theme/ThemeContext/functions/ThemeProvider.md new file mode 100644 index 0000000..51e99b9 --- /dev/null +++ b/docs/theme/ThemeContext/functions/ThemeProvider.md @@ -0,0 +1,35 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [theme/ThemeContext](../README.md) / ThemeProvider + +# Function: ThemeProvider() + +> **ThemeProvider**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +#### children + +`ReactNode` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/theme/ThemeContext.tsx:17](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/theme/ThemeContext.tsx#L17) diff --git a/docs/theme/ThemeContext/variables/ThemeContext.md b/docs/theme/ThemeContext/variables/ThemeContext.md new file mode 100644 index 0000000..c29f8ee --- /dev/null +++ b/docs/theme/ThemeContext/variables/ThemeContext.md @@ -0,0 +1,13 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [theme/ThemeContext](../README.md) / ThemeContext + +# Variable: ThemeContext + +> `const` **ThemeContext**: `Context`\<`ThemeContextType`\> + +## Defined in + +[src/theme/ThemeContext.tsx:12](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/theme/ThemeContext.tsx#L12) diff --git a/docs/theme/theme/variables/darkTheme.md b/docs/theme/theme/variables/darkTheme.md new file mode 100644 index 0000000..785d486 --- /dev/null +++ b/docs/theme/theme/variables/darkTheme.md @@ -0,0 +1,13 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [theme/theme](../README.md) / darkTheme + +# Variable: darkTheme + +> `const` **darkTheme**: `Theme` + +## Defined in + +[src/theme/theme.ts:98](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/theme/theme.ts#L98) diff --git a/docs/theme/theme/variables/lightTheme.md b/docs/theme/theme/variables/lightTheme.md new file mode 100644 index 0000000..a319d3d --- /dev/null +++ b/docs/theme/theme/variables/lightTheme.md @@ -0,0 +1,13 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [theme/theme](../README.md) / lightTheme + +# Variable: lightTheme + +> `const` **lightTheme**: `Theme` + +## Defined in + +[src/theme/theme.ts:84](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/theme/theme.ts#L84) diff --git a/docs/types/Button.types/functions/default.md b/docs/types/Button.types/functions/default.md new file mode 100644 index 0000000..21a6e81 --- /dev/null +++ b/docs/types/Button.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Button.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`ButtonProps`](../interfaces/ButtonProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Button.types.d.ts:22](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L22) diff --git a/docs/types/Button.types/interfaces/ButtonProps.md b/docs/types/Button.types/interfaces/ButtonProps.md new file mode 100644 index 0000000..d46497d --- /dev/null +++ b/docs/types/Button.types/interfaces/ButtonProps.md @@ -0,0 +1,4737 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Button.types](../README.md) / ButtonProps + +# Interface: ButtonProps + +## Extends + +- `Omit`\<`MuiButtonProps`, `"color"`\> + +## Properties + +### about? + +> `optional` **about**: `string` + +#### Inherited from + +`Omit.about` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2920 + +*** + +### accessKey? + +> `optional` **accessKey**: `string` + +#### Inherited from + +`Omit.accessKey` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2895 + +*** + +### action? + +> `optional` **action**: `Ref`\<`ButtonBaseActions`\> + +A ref for imperative actions. +It currently only supports `focusVisible()` action. + +#### Inherited from + +`Omit.action` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:13 + +*** + +### aria-activedescendant? + +> `optional` **aria-activedescendant**: `string` + +Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. + +#### Inherited from + +`Omit.aria-activedescendant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2593 + +*** + +### aria-atomic? + +> `optional` **aria-atomic**: `Booleanish` + +Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. + +#### Inherited from + +`Omit.aria-atomic` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2595 + +*** + +### aria-autocomplete? + +> `optional` **aria-autocomplete**: `"none"` \| `"inline"` \| `"both"` \| `"list"` + +Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made. + +#### Inherited from + +`Omit.aria-autocomplete` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2600 + +*** + +### aria-braillelabel? + +> `optional` **aria-braillelabel**: `string` + +Defines a string value that labels the current element, which is intended to be converted into Braille. + +#### See + +aria-label. + +#### Inherited from + +`Omit.aria-braillelabel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2606 + +*** + +### aria-brailleroledescription? + +> `optional` **aria-brailleroledescription**: `string` + +Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. + +#### See + +aria-roledescription. + +#### Inherited from + +`Omit.aria-brailleroledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2611 + +*** + +### aria-busy? + +> `optional` **aria-busy**: `Booleanish` + +#### Inherited from + +`Omit.aria-busy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2612 + +*** + +### aria-checked? + +> `optional` **aria-checked**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. + +#### See + + - aria-pressed + - aria-selected. + +#### Inherited from + +`Omit.aria-checked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2617 + +*** + +### aria-colcount? + +> `optional` **aria-colcount**: `number` + +Defines the total number of columns in a table, grid, or treegrid. + +#### See + +aria-colindex. + +#### Inherited from + +`Omit.aria-colcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2622 + +*** + +### aria-colindex? + +> `optional` **aria-colindex**: `number` + +Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. + +#### See + + - aria-colcount + - aria-colspan. + +#### Inherited from + +`Omit.aria-colindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2627 + +*** + +### aria-colindextext? + +> `optional` **aria-colindextext**: `string` + +Defines a human readable text alternative of aria-colindex. + +#### See + +aria-rowindextext. + +#### Inherited from + +`Omit.aria-colindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2632 + +*** + +### aria-colspan? + +> `optional` **aria-colspan**: `number` + +Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-colindex + - aria-rowspan. + +#### Inherited from + +`Omit.aria-colspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2637 + +*** + +### aria-controls? + +> `optional` **aria-controls**: `string` + +Identifies the element (or elements) whose contents or presence are controlled by the current element. + +#### See + +aria-owns. + +#### Inherited from + +`Omit.aria-controls` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2642 + +*** + +### aria-current? + +> `optional` **aria-current**: `boolean` \| `"time"` \| `"page"` \| `"false"` \| `"true"` \| `"step"` \| `"location"` \| `"date"` + +Indicates the element that represents the current item within a container or set of related elements. + +#### Inherited from + +`Omit.aria-current` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2644 + +*** + +### aria-describedby? + +> `optional` **aria-describedby**: `string` + +Identifies the element (or elements) that describes the object. + +#### See + +aria-labelledby + +#### Inherited from + +`Omit.aria-describedby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2649 + +*** + +### aria-description? + +> `optional` **aria-description**: `string` + +Defines a string value that describes or annotates the current element. + +#### See + +related aria-describedby. + +#### Inherited from + +`Omit.aria-description` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2654 + +*** + +### aria-details? + +> `optional` **aria-details**: `string` + +Identifies the element that provides a detailed, extended description for the object. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-details` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2659 + +*** + +### aria-disabled? + +> `optional` **aria-disabled**: `Booleanish` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +#### See + + - aria-hidden + - aria-readonly. + +#### Inherited from + +`Omit.aria-disabled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2664 + +*** + +### ~~aria-dropeffect?~~ + +> `optional` **aria-dropeffect**: `"none"` \| `"link"` \| `"copy"` \| `"move"` \| `"execute"` \| `"popup"` + +Indicates what functions can be performed when a dragged object is released on the drop target. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-dropeffect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2669 + +*** + +### aria-errormessage? + +> `optional` **aria-errormessage**: `string` + +Identifies the element that provides an error message for the object. + +#### See + + - aria-invalid + - aria-describedby. + +#### Inherited from + +`Omit.aria-errormessage` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2674 + +*** + +### aria-expanded? + +> `optional` **aria-expanded**: `Booleanish` + +Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. + +#### Inherited from + +`Omit.aria-expanded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2676 + +*** + +### aria-flowto? + +> `optional` **aria-flowto**: `string` + +Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order. + +#### Inherited from + +`Omit.aria-flowto` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2681 + +*** + +### ~~aria-grabbed?~~ + +> `optional` **aria-grabbed**: `Booleanish` + +Indicates an element's "grabbed" state in a drag-and-drop operation. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-grabbed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2686 + +*** + +### aria-haspopup? + +> `optional` **aria-haspopup**: `boolean` \| `"dialog"` \| `"menu"` \| `"grid"` \| `"listbox"` \| `"false"` \| `"true"` \| `"tree"` + +Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. + +#### Inherited from + +`Omit.aria-haspopup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2688 + +*** + +### aria-hidden? + +> `optional` **aria-hidden**: `Booleanish` + +Indicates whether the element is exposed to an accessibility API. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2693 + +*** + +### aria-invalid? + +> `optional` **aria-invalid**: `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` + +Indicates the entered value does not conform to the format expected by the application. + +#### See + +aria-errormessage. + +#### Inherited from + +`Omit.aria-invalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2698 + +*** + +### aria-keyshortcuts? + +> `optional` **aria-keyshortcuts**: `string` + +Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. + +#### Inherited from + +`Omit.aria-keyshortcuts` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2700 + +*** + +### aria-label? + +> `optional` **aria-label**: `string` + +Defines a string value that labels the current element. + +#### See + +aria-labelledby. + +#### Inherited from + +`Omit.aria-label` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2705 + +*** + +### aria-labelledby? + +> `optional` **aria-labelledby**: `string` + +Identifies the element (or elements) that labels the current element. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-labelledby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2710 + +*** + +### aria-level? + +> `optional` **aria-level**: `number` + +Defines the hierarchical level of an element within a structure. + +#### Inherited from + +`Omit.aria-level` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2712 + +*** + +### aria-live? + +> `optional` **aria-live**: `"off"` \| `"assertive"` \| `"polite"` + +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +#### Inherited from + +`Omit.aria-live` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2714 + +*** + +### aria-modal? + +> `optional` **aria-modal**: `Booleanish` + +Indicates whether an element is modal when displayed. + +#### Inherited from + +`Omit.aria-modal` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2716 + +*** + +### aria-multiline? + +> `optional` **aria-multiline**: `Booleanish` + +Indicates whether a text box accepts multiple lines of input or only a single line. + +#### Inherited from + +`Omit.aria-multiline` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2718 + +*** + +### aria-multiselectable? + +> `optional` **aria-multiselectable**: `Booleanish` + +Indicates that the user may select more than one item from the current selectable descendants. + +#### Inherited from + +`Omit.aria-multiselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2720 + +*** + +### aria-orientation? + +> `optional` **aria-orientation**: `"horizontal"` \| `"vertical"` + +Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. + +#### Inherited from + +`Omit.aria-orientation` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2722 + +*** + +### aria-owns? + +> `optional` **aria-owns**: `string` + +Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship. + +#### See + +aria-controls. + +#### Inherited from + +`Omit.aria-owns` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2728 + +*** + +### aria-placeholder? + +> `optional` **aria-placeholder**: `string` + +Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format. + +#### Inherited from + +`Omit.aria-placeholder` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2733 + +*** + +### aria-posinset? + +> `optional` **aria-posinset**: `number` + +Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-setsize. + +#### Inherited from + +`Omit.aria-posinset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2738 + +*** + +### aria-pressed? + +> `optional` **aria-pressed**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "pressed" state of toggle buttons. + +#### See + + - aria-checked + - aria-selected. + +#### Inherited from + +`Omit.aria-pressed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2743 + +*** + +### aria-readonly? + +> `optional` **aria-readonly**: `Booleanish` + +Indicates that the element is not editable, but is otherwise operable. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-readonly` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2748 + +*** + +### aria-relevant? + +> `optional` **aria-relevant**: `"text"` \| `"all"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` + +Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. + +#### See + +aria-atomic. + +#### Inherited from + +`Omit.aria-relevant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2753 + +*** + +### aria-required? + +> `optional` **aria-required**: `Booleanish` + +Indicates that user input is required on the element before a form may be submitted. + +#### Inherited from + +`Omit.aria-required` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2766 + +*** + +### aria-roledescription? + +> `optional` **aria-roledescription**: `string` + +Defines a human-readable, author-localized description for the role of an element. + +#### Inherited from + +`Omit.aria-roledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2768 + +*** + +### aria-rowcount? + +> `optional` **aria-rowcount**: `number` + +Defines the total number of rows in a table, grid, or treegrid. + +#### See + +aria-rowindex. + +#### Inherited from + +`Omit.aria-rowcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2773 + +*** + +### aria-rowindex? + +> `optional` **aria-rowindex**: `number` + +Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. + +#### See + + - aria-rowcount + - aria-rowspan. + +#### Inherited from + +`Omit.aria-rowindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2778 + +*** + +### aria-rowindextext? + +> `optional` **aria-rowindextext**: `string` + +Defines a human readable text alternative of aria-rowindex. + +#### See + +aria-colindextext. + +#### Inherited from + +`Omit.aria-rowindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2783 + +*** + +### aria-rowspan? + +> `optional` **aria-rowspan**: `number` + +Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-rowindex + - aria-colspan. + +#### Inherited from + +`Omit.aria-rowspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2788 + +*** + +### aria-selected? + +> `optional` **aria-selected**: `Booleanish` + +Indicates the current "selected" state of various widgets. + +#### See + + - aria-checked + - aria-pressed. + +#### Inherited from + +`Omit.aria-selected` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2793 + +*** + +### aria-setsize? + +> `optional` **aria-setsize**: `number` + +Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-posinset. + +#### Inherited from + +`Omit.aria-setsize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2798 + +*** + +### aria-sort? + +> `optional` **aria-sort**: `"none"` \| `"ascending"` \| `"descending"` \| `"other"` + +Indicates if items in a table or grid are sorted in ascending or descending order. + +#### Inherited from + +`Omit.aria-sort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2800 + +*** + +### aria-valuemax? + +> `optional` **aria-valuemax**: `number` + +Defines the maximum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemax` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2802 + +*** + +### aria-valuemin? + +> `optional` **aria-valuemin**: `number` + +Defines the minimum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemin` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2804 + +*** + +### aria-valuenow? + +> `optional` **aria-valuenow**: `number` + +Defines the current value for a range widget. + +#### See + +aria-valuetext. + +#### Inherited from + +`Omit.aria-valuenow` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2809 + +*** + +### aria-valuetext? + +> `optional` **aria-valuetext**: `string` + +Defines the human readable text alternative of aria-valuenow for a range widget. + +#### Inherited from + +`Omit.aria-valuetext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2811 + +*** + +### ariaLabel? + +> `optional` **ariaLabel**: `string` + +#### Defined in + +[src/types/Button.types.d.ts:16](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L16) + +*** + +### autoCapitalize? + +> `optional` **autoCapitalize**: `string` + +#### Inherited from + +`Omit.autoCapitalize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2933 + +*** + +### autoCorrect? + +> `optional` **autoCorrect**: `string` + +#### Inherited from + +`Omit.autoCorrect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2934 + +*** + +### autoFocus? + +> `optional` **autoFocus**: `boolean` + +#### Inherited from + +`Omit.autoFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2896 + +*** + +### autoSave? + +> `optional` **autoSave**: `string` + +#### Inherited from + +`Omit.autoSave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2935 + +*** + +### centerRipple? + +> `optional` **centerRipple**: `boolean` + +If `true`, the ripples are centered. +They won't start at the cursor interaction position. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.centerRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:19 + +*** + +### children? + +> `optional` **children**: `ReactNode` + +The content of the component. + +#### Inherited from + +`Omit.children` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:19 + +*** + +### classes? + +> `optional` **classes**: `Partial`\<`ButtonClasses`\> & `Partial`\<`ClassNameMap`\<`never`\>\> + +Override or extend the styles applied to the component. + +#### Inherited from + +`Omit.classes` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:23 + +*** + +### className? + +> `optional` **className**: `string` + +#### Inherited from + +`Omit.className` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:60 + +*** + +### color? + +> `optional` **color**: `"primary"` \| `"secondary"` \| `"inherit"` \| `"error"` \| `"success"` \| `"info"` \| `"warning"` + +#### Defined in + +[src/types/Button.types.d.ts:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L8) + +*** + +### component? + +> `optional` **component**: `ElementType`\<`any`, keyof IntrinsicElements\> + +#### Inherited from + +`Omit.component` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:128 + +*** + +### content? + +> `optional` **content**: `string` + +#### Inherited from + +`Omit.content` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2921 + +*** + +### contentEditable? + +> `optional` **contentEditable**: `"inherit"` \| `Booleanish` \| `"plaintext-only"` + +#### Inherited from + +`Omit.contentEditable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2898 + +*** + +### contextMenu? + +> `optional` **contextMenu**: `string` + +#### Inherited from + +`Omit.contextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2899 + +*** + +### dangerouslySetInnerHTML? + +> `optional` **dangerouslySetInnerHTML**: `object` + +#### \_\_html + +> **\_\_html**: `string` \| `TrustedHTML` + +#### Inherited from + +`Omit.dangerouslySetInnerHTML` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2380 + +*** + +### datatype? + +> `optional` **datatype**: `string` + +#### Inherited from + +`Omit.datatype` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2922 + +*** + +### defaultChecked? + +> `optional` **defaultChecked**: `boolean` + +#### Inherited from + +`Omit.defaultChecked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2889 + +*** + +### defaultValue? + +> `optional` **defaultValue**: `string` \| `number` \| readonly `string`[] + +#### Inherited from + +`Omit.defaultValue` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2890 + +*** + +### dir? + +> `optional` **dir**: `string` + +#### Inherited from + +`Omit.dir` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2900 + +*** + +### disabled? + +> `optional` **disabled**: `boolean` + +If `true`, the component is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disabled` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:38 + +*** + +### disableElevation? + +> `optional` **disableElevation**: `boolean` + +If `true`, no elevation is used. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableElevation` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:43 + +*** + +### disableFocusRipple? + +> `optional` **disableFocusRipple**: `boolean` + +If `true`, the keyboard focus ripple is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableFocusRipple` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:48 + +*** + +### disableRipple? + +> `optional` **disableRipple**: `boolean` + +If `true`, the ripple effect is disabled. + +⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure +to highlight the element by applying separate styles with the `.Mui-focusVisible` class. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:40 + +*** + +### disableTouchRipple? + +> `optional` **disableTouchRipple**: `boolean` + +If `true`, the touch ripple effect is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableTouchRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:45 + +*** + +### draggable? + +> `optional` **draggable**: `Booleanish` + +#### Inherited from + +`Omit.draggable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2901 + +*** + +### endIcon? + +> `optional` **endIcon**: `ReactNode` + +Element placed after the children. + +#### Inherited from + +`Omit.endIcon` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:52 + +*** + +### focusRipple? + +> `optional` **focusRipple**: `boolean` + +If `true`, the base button will have a keyboard focus ripple. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.focusRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:50 + +*** + +### focusVisibleClassName? + +> `optional` **focusVisibleClassName**: `string` + +This prop can help identify which element has keyboard focus. +The class name will be applied when the element gains the focus through keyboard interaction. +It's a polyfill for the [CSS :focus-visible selector](https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo). +The rationale for using this feature [is explained here](https://github.com/WICG/focus-visible/blob/HEAD/explainer.md). +A [polyfill can be used](https://github.com/WICG/focus-visible) to apply a `focus-visible` class to other components +if needed. + +#### Inherited from + +`Omit.focusVisibleClassName` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:59 + +*** + +### form? + +> `optional` **form**: `string` + +#### Inherited from + +`Omit.form` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3136 + +*** + +### formAction? + +> `optional` **formAction**: `string` \| (`formData`) => `void` + +#### Inherited from + +`Omit.formAction` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3137 + +*** + +### formEncType? + +> `optional` **formEncType**: `string` + +#### Inherited from + +`Omit.formEncType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3143 + +*** + +### formMethod? + +> `optional` **formMethod**: `string` + +#### Inherited from + +`Omit.formMethod` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3144 + +*** + +### formNoValidate? + +> `optional` **formNoValidate**: `boolean` + +#### Inherited from + +`Omit.formNoValidate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3145 + +*** + +### formTarget? + +> `optional` **formTarget**: `string` + +#### Inherited from + +`Omit.formTarget` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3146 + +*** + +### fullWidth? + +> `optional` **fullWidth**: `boolean` + +If `true`, the button will take up the full width of its container. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.fullWidth` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:57 + +*** + +### hidden? + +> `optional` **hidden**: `boolean` + +#### Inherited from + +`Omit.hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2902 + +*** + +### href? + +> `optional` **href**: `string` + +The URL to link to when the button is clicked. +If defined, an `a` element will be used as the root node. + +#### Inherited from + +`Omit.href` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:62 + +*** + +### id? + +> `optional` **id**: `string` + +#### Inherited from + +`Omit.id` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2903 + +*** + +### inert? + +> `optional` **inert**: `boolean` + +#### See + +https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert + +#### Inherited from + +`Omit.inert` + +#### Defined in + +node\_modules/@types/react/experimental.d.ts:125 + +*** + +### inlist? + +> `optional` **inlist**: `any` + +#### Inherited from + +`Omit.inlist` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2923 + +*** + +### inputMode? + +> `optional` **inputMode**: `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` + +Hints at the type of data that might be entered by the user while editing the element or its contents + +#### See + +[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) + +#### Inherited from + +`Omit.inputMode` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2951 + +*** + +### is? + +> `optional` **is**: `string` + +Specify that a standard HTML element should behave like a defined custom built-in element + +#### See + +[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) + +#### Inherited from + +`Omit.is` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2956 + +*** + +### itemID? + +> `optional` **itemID**: `string` + +#### Inherited from + +`Omit.itemID` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2940 + +*** + +### itemProp? + +> `optional` **itemProp**: `string` + +#### Inherited from + +`Omit.itemProp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2937 + +*** + +### itemRef? + +> `optional` **itemRef**: `string` + +#### Inherited from + +`Omit.itemRef` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2941 + +*** + +### itemScope? + +> `optional` **itemScope**: `boolean` + +#### Inherited from + +`Omit.itemScope` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2938 + +*** + +### itemType? + +> `optional` **itemType**: `string` + +#### Inherited from + +`Omit.itemType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2939 + +*** + +### key? + +> `optional` **key**: `null` \| `Key` + +#### Inherited from + +`Omit.key` + +#### Defined in + +node\_modules/@types/react/index.d.ts:261 + +*** + +### label + +> **label**: `string` + +#### Defined in + +[src/types/Button.types.d.ts:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L7) + +*** + +### lang? + +> `optional` **lang**: `string` + +#### Inherited from + +`Omit.lang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2904 + +*** + +### LinkComponent? + +> `optional` **LinkComponent**: `ElementType`\<`any`, keyof IntrinsicElements\> + +The component used to render a link when the `href` prop is provided. + +#### Default + +```ts +'a' +``` + +#### Inherited from + +`Omit.LinkComponent` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:64 + +*** + +### name? + +> `optional` **name**: `string` + +#### Inherited from + +`Omit.name` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3147 + +*** + +### nonce? + +> `optional` **nonce**: `string` + +#### Inherited from + +`Omit.nonce` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2905 + +*** + +### onAbort? + +> `optional` **onAbort**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2439 + +*** + +### onAbortCapture? + +> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbortCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2440 + +*** + +### onAnimationEnd? + +> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2569 + +*** + +### onAnimationEndCapture? + +> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2570 + +*** + +### onAnimationIteration? + +> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIteration` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2571 + +*** + +### onAnimationIterationCapture? + +> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIterationCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2572 + +*** + +### onAnimationStart? + +> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2567 + +*** + +### onAnimationStartCapture? + +> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2568 + +*** + +### onAuxClick? + +> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2487 + +*** + +### onAuxClickCapture? + +> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2488 + +*** + +### onBeforeInput? + +> `optional` **onBeforeInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2411 + +*** + +### onBeforeInputCapture? + +> `optional` **onBeforeInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2412 + +*** + +### onBeforeToggle? + +> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:131 + +*** + +### onBlur? + +> `optional` **onBlur**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlur` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2405 + +*** + +### onBlurCapture? + +> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlurCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2406 + +*** + +### onCanPlay? + +> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2441 + +*** + +### onCanPlayCapture? + +> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2442 + +*** + +### onCanPlayThrough? + +> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThrough` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2443 + +*** + +### onCanPlayThroughCapture? + +> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThroughCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2444 + +*** + +### onChange? + +> `optional` **onChange**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2409 + +*** + +### onChangeCapture? + +> `optional` **onChangeCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2410 + +*** + +### onClick? + +> `optional` **onClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2489 + +*** + +### onClickCapture? + +> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2490 + +*** + +### onCompositionEnd? + +> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2395 + +*** + +### onCompositionEndCapture? + +> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2396 + +*** + +### onCompositionStart? + +> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2397 + +*** + +### onCompositionStartCapture? + +> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2398 + +*** + +### onCompositionUpdate? + +> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2399 + +*** + +### onCompositionUpdateCapture? + +> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2400 + +*** + +### onContextMenu? + +> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2491 + +*** + +### onContextMenuCapture? + +> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenuCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2492 + +*** + +### onCopy? + +> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2387 + +*** + +### onCopyCapture? + +> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopyCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2388 + +*** + +### onCut? + +> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2389 + +*** + +### onCutCapture? + +> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2390 + +*** + +### onDoubleClick? + +> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2493 + +*** + +### onDoubleClickCapture? + +> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2494 + +*** + +### onDrag? + +> `optional` **onDrag**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrag` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2495 + +*** + +### onDragCapture? + +> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2496 + +*** + +### onDragEnd? + +> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2497 + +*** + +### onDragEndCapture? + +> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2498 + +*** + +### onDragEnter? + +> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2499 + +*** + +### onDragEnterCapture? + +> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnterCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2500 + +*** + +### onDragExit? + +> `optional` **onDragExit**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2501 + +*** + +### onDragExitCapture? + +> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2502 + +*** + +### onDragLeave? + +> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2503 + +*** + +### onDragLeaveCapture? + +> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeaveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2504 + +*** + +### onDragOver? + +> `optional` **onDragOver**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2505 + +*** + +### onDragOverCapture? + +> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2506 + +*** + +### onDragStart? + +> `optional` **onDragStart**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2507 + +*** + +### onDragStartCapture? + +> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2508 + +*** + +### onDrop? + +> `optional` **onDrop**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrop` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2509 + +*** + +### onDropCapture? + +> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDropCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2510 + +*** + +### onDurationChange? + +> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2445 + +*** + +### onDurationChangeCapture? + +> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2446 + +*** + +### onEmptied? + +> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptied` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2447 + +*** + +### onEmptiedCapture? + +> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptiedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2448 + +*** + +### onEncrypted? + +> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncrypted` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2449 + +*** + +### onEncryptedCapture? + +> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncryptedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2450 + +*** + +### onEnded? + +> `optional` **onEnded**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEnded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2451 + +*** + +### onEndedCapture? + +> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEndedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2452 + +*** + +### onError? + +> `optional` **onError**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onError` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2425 + +*** + +### onErrorCapture? + +> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onErrorCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2426 + +*** + +### onFocus? + +> `optional` **onFocus**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2403 + +*** + +### onFocusCapture? + +> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocusCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2404 + +*** + +### onFocusVisible? + +> `optional` **onFocusVisible**: `FocusEventHandler`\<`any`\> + +Callback fired when the component is focused with a keyboard. +We trigger a `onFocus` callback too. + +#### Inherited from + +`Omit.onFocusVisible` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:69 + +*** + +### onGotPointerCapture? + +> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2553 + +*** + +### onGotPointerCaptureCapture? + +> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2554 + +*** + +### onInput? + +> `optional` **onInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2413 + +*** + +### onInputCapture? + +> `optional` **onInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2414 + +*** + +### onInvalid? + +> `optional` **onInvalid**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2419 + +*** + +### onInvalidCapture? + +> `optional` **onInvalidCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalidCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2420 + +*** + +### onKeyDown? + +> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2429 + +*** + +### onKeyDownCapture? + +> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2430 + +*** + +### ~~onKeyPress?~~ + +> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUp` or `onKeyDown` instead + +#### Inherited from + +`Omit.onKeyPress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2432 + +*** + +### ~~onKeyPressCapture?~~ + +> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUpCapture` or `onKeyDownCapture` instead + +#### Inherited from + +`Omit.onKeyPressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2434 + +*** + +### onKeyUp? + +> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2435 + +*** + +### onKeyUpCapture? + +> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2436 + +*** + +### onLoad? + +> `optional` **onLoad**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoad` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2423 + +*** + +### onLoadCapture? + +> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2424 + +*** + +### onLoadedData? + +> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedData` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2453 + +*** + +### onLoadedDataCapture? + +> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedDataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2454 + +*** + +### onLoadedMetadata? + +> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadata` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2455 + +*** + +### onLoadedMetadataCapture? + +> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2456 + +*** + +### onLoadStart? + +> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2457 + +*** + +### onLoadStartCapture? + +> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2458 + +*** + +### onLostPointerCapture? + +> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2555 + +*** + +### onLostPointerCaptureCapture? + +> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2556 + +*** + +### onMouseDown? + +> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2511 + +*** + +### onMouseDownCapture? + +> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2512 + +*** + +### onMouseEnter? + +> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2513 + +*** + +### onMouseLeave? + +> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2514 + +*** + +### onMouseMove? + +> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2515 + +*** + +### onMouseMoveCapture? + +> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2516 + +*** + +### onMouseOut? + +> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2517 + +*** + +### onMouseOutCapture? + +> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2518 + +*** + +### onMouseOver? + +> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2519 + +*** + +### onMouseOverCapture? + +> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2520 + +*** + +### onMouseUp? + +> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2521 + +*** + +### onMouseUpCapture? + +> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2522 + +*** + +### onPaste? + +> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPaste` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2391 + +*** + +### onPasteCapture? + +> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPasteCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2392 + +*** + +### onPause? + +> `optional` **onPause**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPause` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2459 + +*** + +### onPauseCapture? + +> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPauseCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2460 + +*** + +### onPlay? + +> `optional` **onPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2461 + +*** + +### onPlayCapture? + +> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2462 + +*** + +### onPlaying? + +> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlaying` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2463 + +*** + +### onPlayingCapture? + +> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2464 + +*** + +### onPointerCancel? + +> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2545 + +*** + +### onPointerCancelCapture? + +> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2546 + +*** + +### onPointerDown? + +> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2539 + +*** + +### onPointerDownCapture? + +> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2540 + +*** + +### onPointerEnter? + +> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2547 + +*** + +### onPointerLeave? + +> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2548 + +*** + +### onPointerMove? + +> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2541 + +*** + +### onPointerMoveCapture? + +> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2542 + +*** + +### onPointerOut? + +> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2551 + +*** + +### onPointerOutCapture? + +> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2552 + +*** + +### onPointerOver? + +> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2549 + +*** + +### onPointerOverCapture? + +> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2550 + +*** + +### onPointerUp? + +> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2543 + +*** + +### onPointerUpCapture? + +> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2544 + +*** + +### onProgress? + +> `optional` **onProgress**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2465 + +*** + +### onProgressCapture? + +> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2466 + +*** + +### onRateChange? + +> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2467 + +*** + +### onRateChangeCapture? + +> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2468 + +*** + +### onReset? + +> `optional` **onReset**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onReset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2415 + +*** + +### onResetCapture? + +> `optional` **onResetCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResetCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2416 + +*** + +### onResize? + +> `optional` **onResize**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2469 + +*** + +### onResizeCapture? + +> `optional` **onResizeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResizeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2470 + +*** + +### onScroll? + +> `optional` **onScroll**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScroll` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2559 + +*** + +### onScrollCapture? + +> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScrollCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2560 + +*** + +### onSeeked? + +> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2471 + +*** + +### onSeekedCapture? + +> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2472 + +*** + +### onSeeking? + +> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeking` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2473 + +*** + +### onSeekingCapture? + +> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2474 + +*** + +### onSelect? + +> `optional` **onSelect**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2525 + +*** + +### onSelectCapture? + +> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelectCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2526 + +*** + +### onStalled? + +> `optional` **onStalled**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2475 + +*** + +### onStalledCapture? + +> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalledCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2476 + +*** + +### onSubmit? + +> `optional` **onSubmit**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2417 + +*** + +### onSubmitCapture? + +> `optional` **onSubmitCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2418 + +*** + +### onSuspend? + +> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspend` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2477 + +*** + +### onSuspendCapture? + +> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspendCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2478 + +*** + +### onTimeUpdate? + +> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2479 + +*** + +### onTimeUpdateCapture? + +> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2480 + +*** + +### onToggle? + +> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:130 + +*** + +### onTouchCancel? + +> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2529 + +*** + +### onTouchCancelCapture? + +> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2530 + +*** + +### onTouchEnd? + +> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2531 + +*** + +### onTouchEndCapture? + +> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2532 + +*** + +### onTouchMove? + +> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2533 + +*** + +### onTouchMoveCapture? + +> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2534 + +*** + +### onTouchStart? + +> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2535 + +*** + +### onTouchStartCapture? + +> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2536 + +*** + +### onTransitionCancel? + +> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancel` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:116 + +*** + +### onTransitionCancelCapture? + +> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancelCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:117 + +*** + +### onTransitionEnd? + +> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2575 + +*** + +### onTransitionEndCapture? + +> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2576 + +*** + +### onTransitionRun? + +> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRun` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:118 + +*** + +### onTransitionRunCapture? + +> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRunCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:119 + +*** + +### onTransitionStart? + +> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStart` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:120 + +*** + +### onTransitionStartCapture? + +> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStartCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:121 + +*** + +### onVolumeChange? + +> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2481 + +*** + +### onVolumeChangeCapture? + +> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2482 + +*** + +### onWaiting? + +> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaiting` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2483 + +*** + +### onWaitingCapture? + +> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaitingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2484 + +*** + +### onWheel? + +> `optional` **onWheel**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2563 + +*** + +### onWheelCapture? + +> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2564 + +*** + +### popover? + +> `optional` **popover**: `""` \| `"auto"` \| `"manual"` + +#### Inherited from + +`Omit.popover` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:127 + +*** + +### popoverTarget? + +> `optional` **popoverTarget**: `string` + +#### Inherited from + +`Omit.popoverTarget` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:129 + +*** + +### popoverTargetAction? + +> `optional` **popoverTargetAction**: `"hide"` \| `"show"` \| `"toggle"` + +#### Inherited from + +`Omit.popoverTargetAction` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:128 + +*** + +### prefix? + +> `optional` **prefix**: `string` + +#### Inherited from + +`Omit.prefix` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2924 + +*** + +### property? + +> `optional` **property**: `string` + +#### Inherited from + +`Omit.property` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2925 + +*** + +### radioGroup? + +> `optional` **radioGroup**: `string` + +#### Inherited from + +`Omit.radioGroup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2914 + +*** + +### ref? + +> `optional` **ref**: `null` \| (`instance`) => `void` \| () => `VoidOrUndefinedOnly` \| `RefObject`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.ref` + +#### Defined in + +node\_modules/@types/react/index.d.ts:1619 + +*** + +### rel? + +> `optional` **rel**: `string` + +#### Inherited from + +`Omit.rel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2926 + +*** + +### resource? + +> `optional` **resource**: `string` + +#### Inherited from + +`Omit.resource` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2927 + +*** + +### results? + +> `optional` **results**: `number` + +#### Inherited from + +`Omit.results` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2942 + +*** + +### rev? + +> `optional` **rev**: `string` + +#### Inherited from + +`Omit.rev` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2928 + +*** + +### role? + +> `optional` **role**: `string` + +#### Overrides + +`Omit.role` + +#### Defined in + +[src/types/Button.types.d.ts:18](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L18) + +*** + +### security? + +> `optional` **security**: `string` + +#### Inherited from + +`Omit.security` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2943 + +*** + +### size? + +> `optional` **size**: `OverridableStringUnion`\<`"large"` \| `"medium"` \| `"small"`, `ButtonPropsSizeOverrides`\> + +The size of the component. +`small` is equivalent to the dense button styling. + +#### Default + +```ts +'medium' +``` + +#### Inherited from + +`Omit.size` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:68 + +*** + +### slot? + +> `optional` **slot**: `string` + +#### Inherited from + +`Omit.slot` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2906 + +*** + +### spellCheck? + +> `optional` **spellCheck**: `Booleanish` + +#### Inherited from + +`Omit.spellCheck` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2907 + +*** + +### startIcon? + +> `optional` **startIcon**: `ReactNode` + +Element placed before the children. + +#### Inherited from + +`Omit.startIcon` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:72 + +*** + +### style? + +> `optional` **style**: `CSSProperties` + +#### Inherited from + +`Omit.style` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:61 + +*** + +### suppressContentEditableWarning? + +> `optional` **suppressContentEditableWarning**: `boolean` + +#### Inherited from + +`Omit.suppressContentEditableWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2891 + +*** + +### suppressHydrationWarning? + +> `optional` **suppressHydrationWarning**: `boolean` + +#### Inherited from + +`Omit.suppressHydrationWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2892 + +*** + +### sx? + +> `optional` **sx**: `SxProps`\<`Theme`\> + +The system prop that allows defining system overrides as well as additional CSS styles. + +#### Overrides + +`Omit.sx` + +#### Defined in + +[src/types/Button.types.d.ts:19](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L19) + +*** + +### tabIndex? + +> `optional` **tabIndex**: `number` + +#### Default + +```ts +0 +``` + +#### Overrides + +`Omit.tabIndex` + +#### Defined in + +[src/types/Button.types.d.ts:17](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Button.types.d.ts#L17) + +*** + +### title? + +> `optional` **title**: `string` + +#### Inherited from + +`Omit.title` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2910 + +*** + +### TouchRippleProps? + +> `optional` **TouchRippleProps**: `Partial`\<`TouchRippleProps`\> + +Props applied to the `TouchRipple` element. + +#### Inherited from + +`Omit.TouchRippleProps` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:81 + +*** + +### touchRippleRef? + +> `optional` **touchRippleRef**: `Ref`\<`TouchRippleActions`\> + +A ref that points to the `TouchRipple` element. + +#### Inherited from + +`Omit.touchRippleRef` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:85 + +*** + +### translate? + +> `optional` **translate**: `"yes"` \| `"no"` + +#### Inherited from + +`Omit.translate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2911 + +*** + +### type? + +> `optional` **type**: `"button"` \| `"reset"` \| `"submit"` + +#### Inherited from + +`Omit.type` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3148 + +*** + +### typeof? + +> `optional` **typeof**: `string` + +#### Inherited from + +`Omit.typeof` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2929 + +*** + +### unselectable? + +> `optional` **unselectable**: `"on"` \| `"off"` + +#### Inherited from + +`Omit.unselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2944 + +*** + +### value? + +> `optional` **value**: `string` \| `number` \| readonly `string`[] + +#### Inherited from + +`Omit.value` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3149 + +*** + +### variant? + +> `optional` **variant**: `OverridableStringUnion`\<`"text"` \| `"outlined"` \| `"contained"`, `ButtonPropsVariantOverrides`\> + +The variant to use. + +#### Default + +```ts +'text' +``` + +#### Inherited from + +`Omit.variant` + +#### Defined in + +node\_modules/@mui/material/Button/Button.d.ts:81 + +*** + +### vocab? + +> `optional` **vocab**: `string` + +#### Inherited from + +`Omit.vocab` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2930 diff --git a/docs/types/Checkbox.types/functions/default.md b/docs/types/Checkbox.types/functions/default.md new file mode 100644 index 0000000..7fe747c --- /dev/null +++ b/docs/types/Checkbox.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Checkbox.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`CheckboxProps`](../interfaces/CheckboxProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Checkbox.types.d.ts:15](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L15) diff --git a/docs/types/Checkbox.types/interfaces/CheckboxProps.md b/docs/types/Checkbox.types/interfaces/CheckboxProps.md new file mode 100644 index 0000000..e755c97 --- /dev/null +++ b/docs/types/Checkbox.types/interfaces/CheckboxProps.md @@ -0,0 +1,4822 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Checkbox.types](../README.md) / CheckboxProps + +# Interface: CheckboxProps + +## Extends + +- `Omit`\<`MuiCheckboxProps`, `"onChange"`\> + +## Properties + +### about? + +> `optional` **about**: `string` + +#### Inherited from + +`Omit.about` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2920 + +*** + +### accessKey? + +> `optional` **accessKey**: `string` + +#### Inherited from + +`Omit.accessKey` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2895 + +*** + +### action? + +> `optional` **action**: `Ref`\<`ButtonBaseActions`\> + +A ref for imperative actions. +It currently only supports `focusVisible()` action. + +#### Inherited from + +`Omit.action` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:13 + +*** + +### aria-activedescendant? + +> `optional` **aria-activedescendant**: `string` + +Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. + +#### Inherited from + +`Omit.aria-activedescendant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2593 + +*** + +### aria-atomic? + +> `optional` **aria-atomic**: `Booleanish` + +Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. + +#### Inherited from + +`Omit.aria-atomic` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2595 + +*** + +### aria-autocomplete? + +> `optional` **aria-autocomplete**: `"none"` \| `"inline"` \| `"both"` \| `"list"` + +Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made. + +#### Inherited from + +`Omit.aria-autocomplete` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2600 + +*** + +### aria-braillelabel? + +> `optional` **aria-braillelabel**: `string` + +Defines a string value that labels the current element, which is intended to be converted into Braille. + +#### See + +aria-label. + +#### Inherited from + +`Omit.aria-braillelabel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2606 + +*** + +### aria-brailleroledescription? + +> `optional` **aria-brailleroledescription**: `string` + +Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. + +#### See + +aria-roledescription. + +#### Inherited from + +`Omit.aria-brailleroledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2611 + +*** + +### aria-busy? + +> `optional` **aria-busy**: `Booleanish` + +#### Inherited from + +`Omit.aria-busy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2612 + +*** + +### aria-checked? + +> `optional` **aria-checked**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. + +#### See + + - aria-pressed + - aria-selected. + +#### Inherited from + +`Omit.aria-checked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2617 + +*** + +### aria-colcount? + +> `optional` **aria-colcount**: `number` + +Defines the total number of columns in a table, grid, or treegrid. + +#### See + +aria-colindex. + +#### Inherited from + +`Omit.aria-colcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2622 + +*** + +### aria-colindex? + +> `optional` **aria-colindex**: `number` + +Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. + +#### See + + - aria-colcount + - aria-colspan. + +#### Inherited from + +`Omit.aria-colindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2627 + +*** + +### aria-colindextext? + +> `optional` **aria-colindextext**: `string` + +Defines a human readable text alternative of aria-colindex. + +#### See + +aria-rowindextext. + +#### Inherited from + +`Omit.aria-colindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2632 + +*** + +### aria-colspan? + +> `optional` **aria-colspan**: `number` + +Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-colindex + - aria-rowspan. + +#### Inherited from + +`Omit.aria-colspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2637 + +*** + +### aria-controls? + +> `optional` **aria-controls**: `string` + +Identifies the element (or elements) whose contents or presence are controlled by the current element. + +#### See + +aria-owns. + +#### Inherited from + +`Omit.aria-controls` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2642 + +*** + +### aria-current? + +> `optional` **aria-current**: `boolean` \| `"time"` \| `"page"` \| `"false"` \| `"true"` \| `"step"` \| `"location"` \| `"date"` + +Indicates the element that represents the current item within a container or set of related elements. + +#### Inherited from + +`Omit.aria-current` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2644 + +*** + +### aria-describedby? + +> `optional` **aria-describedby**: `string` + +Identifies the element (or elements) that describes the object. + +#### See + +aria-labelledby + +#### Inherited from + +`Omit.aria-describedby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2649 + +*** + +### aria-description? + +> `optional` **aria-description**: `string` + +Defines a string value that describes or annotates the current element. + +#### See + +related aria-describedby. + +#### Inherited from + +`Omit.aria-description` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2654 + +*** + +### aria-details? + +> `optional` **aria-details**: `string` + +Identifies the element that provides a detailed, extended description for the object. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-details` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2659 + +*** + +### aria-disabled? + +> `optional` **aria-disabled**: `Booleanish` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +#### See + + - aria-hidden + - aria-readonly. + +#### Inherited from + +`Omit.aria-disabled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2664 + +*** + +### ~~aria-dropeffect?~~ + +> `optional` **aria-dropeffect**: `"none"` \| `"link"` \| `"copy"` \| `"move"` \| `"execute"` \| `"popup"` + +Indicates what functions can be performed when a dragged object is released on the drop target. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-dropeffect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2669 + +*** + +### aria-errormessage? + +> `optional` **aria-errormessage**: `string` + +Identifies the element that provides an error message for the object. + +#### See + + - aria-invalid + - aria-describedby. + +#### Inherited from + +`Omit.aria-errormessage` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2674 + +*** + +### aria-expanded? + +> `optional` **aria-expanded**: `Booleanish` + +Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. + +#### Inherited from + +`Omit.aria-expanded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2676 + +*** + +### aria-flowto? + +> `optional` **aria-flowto**: `string` + +Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order. + +#### Inherited from + +`Omit.aria-flowto` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2681 + +*** + +### ~~aria-grabbed?~~ + +> `optional` **aria-grabbed**: `Booleanish` + +Indicates an element's "grabbed" state in a drag-and-drop operation. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-grabbed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2686 + +*** + +### aria-haspopup? + +> `optional` **aria-haspopup**: `boolean` \| `"dialog"` \| `"menu"` \| `"grid"` \| `"listbox"` \| `"false"` \| `"true"` \| `"tree"` + +Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. + +#### Inherited from + +`Omit.aria-haspopup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2688 + +*** + +### aria-hidden? + +> `optional` **aria-hidden**: `Booleanish` + +Indicates whether the element is exposed to an accessibility API. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2693 + +*** + +### aria-invalid? + +> `optional` **aria-invalid**: `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` + +Indicates the entered value does not conform to the format expected by the application. + +#### See + +aria-errormessage. + +#### Inherited from + +`Omit.aria-invalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2698 + +*** + +### aria-keyshortcuts? + +> `optional` **aria-keyshortcuts**: `string` + +Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. + +#### Inherited from + +`Omit.aria-keyshortcuts` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2700 + +*** + +### aria-label? + +> `optional` **aria-label**: `string` + +Defines a string value that labels the current element. + +#### See + +aria-labelledby. + +#### Inherited from + +`Omit.aria-label` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2705 + +*** + +### aria-labelledby? + +> `optional` **aria-labelledby**: `string` + +Identifies the element (or elements) that labels the current element. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-labelledby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2710 + +*** + +### aria-level? + +> `optional` **aria-level**: `number` + +Defines the hierarchical level of an element within a structure. + +#### Inherited from + +`Omit.aria-level` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2712 + +*** + +### aria-live? + +> `optional` **aria-live**: `"off"` \| `"assertive"` \| `"polite"` + +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +#### Inherited from + +`Omit.aria-live` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2714 + +*** + +### aria-modal? + +> `optional` **aria-modal**: `Booleanish` + +Indicates whether an element is modal when displayed. + +#### Inherited from + +`Omit.aria-modal` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2716 + +*** + +### aria-multiline? + +> `optional` **aria-multiline**: `Booleanish` + +Indicates whether a text box accepts multiple lines of input or only a single line. + +#### Inherited from + +`Omit.aria-multiline` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2718 + +*** + +### aria-multiselectable? + +> `optional` **aria-multiselectable**: `Booleanish` + +Indicates that the user may select more than one item from the current selectable descendants. + +#### Inherited from + +`Omit.aria-multiselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2720 + +*** + +### aria-orientation? + +> `optional` **aria-orientation**: `"horizontal"` \| `"vertical"` + +Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. + +#### Inherited from + +`Omit.aria-orientation` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2722 + +*** + +### aria-owns? + +> `optional` **aria-owns**: `string` + +Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship. + +#### See + +aria-controls. + +#### Inherited from + +`Omit.aria-owns` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2728 + +*** + +### aria-placeholder? + +> `optional` **aria-placeholder**: `string` + +Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format. + +#### Inherited from + +`Omit.aria-placeholder` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2733 + +*** + +### aria-posinset? + +> `optional` **aria-posinset**: `number` + +Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-setsize. + +#### Inherited from + +`Omit.aria-posinset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2738 + +*** + +### aria-pressed? + +> `optional` **aria-pressed**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "pressed" state of toggle buttons. + +#### See + + - aria-checked + - aria-selected. + +#### Inherited from + +`Omit.aria-pressed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2743 + +*** + +### aria-readonly? + +> `optional` **aria-readonly**: `Booleanish` + +Indicates that the element is not editable, but is otherwise operable. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-readonly` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2748 + +*** + +### aria-relevant? + +> `optional` **aria-relevant**: `"text"` \| `"all"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` + +Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. + +#### See + +aria-atomic. + +#### Inherited from + +`Omit.aria-relevant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2753 + +*** + +### aria-required? + +> `optional` **aria-required**: `Booleanish` + +Indicates that user input is required on the element before a form may be submitted. + +#### Inherited from + +`Omit.aria-required` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2766 + +*** + +### aria-roledescription? + +> `optional` **aria-roledescription**: `string` + +Defines a human-readable, author-localized description for the role of an element. + +#### Inherited from + +`Omit.aria-roledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2768 + +*** + +### aria-rowcount? + +> `optional` **aria-rowcount**: `number` + +Defines the total number of rows in a table, grid, or treegrid. + +#### See + +aria-rowindex. + +#### Inherited from + +`Omit.aria-rowcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2773 + +*** + +### aria-rowindex? + +> `optional` **aria-rowindex**: `number` + +Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. + +#### See + + - aria-rowcount + - aria-rowspan. + +#### Inherited from + +`Omit.aria-rowindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2778 + +*** + +### aria-rowindextext? + +> `optional` **aria-rowindextext**: `string` + +Defines a human readable text alternative of aria-rowindex. + +#### See + +aria-colindextext. + +#### Inherited from + +`Omit.aria-rowindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2783 + +*** + +### aria-rowspan? + +> `optional` **aria-rowspan**: `number` + +Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-rowindex + - aria-colspan. + +#### Inherited from + +`Omit.aria-rowspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2788 + +*** + +### aria-selected? + +> `optional` **aria-selected**: `Booleanish` + +Indicates the current "selected" state of various widgets. + +#### See + + - aria-checked + - aria-pressed. + +#### Inherited from + +`Omit.aria-selected` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2793 + +*** + +### aria-setsize? + +> `optional` **aria-setsize**: `number` + +Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-posinset. + +#### Inherited from + +`Omit.aria-setsize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2798 + +*** + +### aria-sort? + +> `optional` **aria-sort**: `"none"` \| `"ascending"` \| `"descending"` \| `"other"` + +Indicates if items in a table or grid are sorted in ascending or descending order. + +#### Inherited from + +`Omit.aria-sort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2800 + +*** + +### aria-valuemax? + +> `optional` **aria-valuemax**: `number` + +Defines the maximum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemax` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2802 + +*** + +### aria-valuemin? + +> `optional` **aria-valuemin**: `number` + +Defines the minimum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemin` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2804 + +*** + +### aria-valuenow? + +> `optional` **aria-valuenow**: `number` + +Defines the current value for a range widget. + +#### See + +aria-valuetext. + +#### Inherited from + +`Omit.aria-valuenow` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2809 + +*** + +### aria-valuetext? + +> `optional` **aria-valuetext**: `string` + +Defines the human readable text alternative of aria-valuenow for a range widget. + +#### Inherited from + +`Omit.aria-valuetext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2811 + +*** + +### ariaLabel? + +> `optional` **ariaLabel**: `string` + +#### Defined in + +[src/types/Checkbox.types.d.ts:12](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L12) + +*** + +### autoCapitalize? + +> `optional` **autoCapitalize**: `string` + +#### Inherited from + +`Omit.autoCapitalize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2933 + +*** + +### autoCorrect? + +> `optional` **autoCorrect**: `string` + +#### Inherited from + +`Omit.autoCorrect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2934 + +*** + +### autoFocus? + +> `optional` **autoFocus**: `boolean` + +#### Inherited from + +`Omit.autoFocus` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:8 + +*** + +### autoSave? + +> `optional` **autoSave**: `string` + +#### Inherited from + +`Omit.autoSave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2935 + +*** + +### centerRipple? + +> `optional` **centerRipple**: `boolean` + +If `true`, the ripples are centered. +They won't start at the cursor interaction position. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.centerRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:19 + +*** + +### checked + +> **checked**: `boolean` + +If `true`, the component is checked. + +#### Overrides + +`Omit.checked` + +#### Defined in + +[src/types/Checkbox.types.d.ts:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L7) + +*** + +### checkedIcon? + +> `optional` **checkedIcon**: `ReactNode` + +The icon to display when the component is checked. + +#### Default + +```ts + +``` + +#### Inherited from + +`Omit.checkedIcon` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:22 + +*** + +### classes? + +> `optional` **classes**: `Partial`\<`CheckboxClasses`\> + +Override or extend the styles applied to the component. + +#### Inherited from + +`Omit.classes` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:26 + +*** + +### className? + +> `optional` **className**: `string` + +#### Inherited from + +`Omit.className` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:60 + +*** + +### color? + +> `optional` **color**: `OverridableStringUnion`\<`"default"` \| `"primary"` \| `"secondary"` \| `"error"` \| `"success"` \| `"info"` \| `"warning"`, `CheckboxPropsColorOverrides`\> + +The color of the component. +It supports both default and custom theme colors, which can be added as shown in the +[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors). + +#### Default + +```ts +'primary' +``` + +#### Inherited from + +`Omit.color` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:33 + +*** + +### component? + +> `optional` **component**: `ElementType`\<`any`, keyof IntrinsicElements\> + +#### Inherited from + +`Omit.component` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:130 + +*** + +### content? + +> `optional` **content**: `string` + +#### Inherited from + +`Omit.content` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2921 + +*** + +### contentEditable? + +> `optional` **contentEditable**: `"inherit"` \| `Booleanish` \| `"plaintext-only"` + +#### Inherited from + +`Omit.contentEditable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2898 + +*** + +### contextMenu? + +> `optional` **contextMenu**: `string` + +#### Inherited from + +`Omit.contextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2899 + +*** + +### dangerouslySetInnerHTML? + +> `optional` **dangerouslySetInnerHTML**: `object` + +#### \_\_html + +> **\_\_html**: `string` \| `TrustedHTML` + +#### Inherited from + +`Omit.dangerouslySetInnerHTML` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2380 + +*** + +### datatype? + +> `optional` **datatype**: `string` + +#### Inherited from + +`Omit.datatype` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2922 + +*** + +### defaultChecked? + +> `optional` **defaultChecked**: `boolean` + +The default checked state. Use when the component is not controlled. + +#### Inherited from + +`Omit.defaultChecked` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:21 + +*** + +### defaultValue? + +> `optional` **defaultValue**: `string` \| `number` \| readonly `string`[] + +#### Inherited from + +`Omit.defaultValue` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2890 + +*** + +### dir? + +> `optional` **dir**: `string` + +#### Inherited from + +`Omit.dir` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2900 + +*** + +### disabled? + +> `optional` **disabled**: `boolean` + +If `true`, the component is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disabled` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:41 + +*** + +### disableFocusRipple? + +> `optional` **disableFocusRipple**: `boolean` + +If `true`, the keyboard focus ripple is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableFocusRipple` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:35 + +*** + +### disableRipple? + +> `optional` **disableRipple**: `boolean` + +If `true`, the ripple effect is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableRipple` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:46 + +*** + +### disableTouchRipple? + +> `optional` **disableTouchRipple**: `boolean` + +If `true`, the touch ripple effect is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableTouchRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:45 + +*** + +### draggable? + +> `optional` **draggable**: `Booleanish` + +#### Inherited from + +`Omit.draggable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2901 + +*** + +### edge? + +> `optional` **edge**: `false` \| `"end"` \| `"start"` + +If given, uses a negative margin to counteract the padding on one +side (this is often helpful for aligning the left or right +side of the icon with content above or below, without ruining the border +size and shape). + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.edge` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:43 + +*** + +### focusRipple? + +> `optional` **focusRipple**: `boolean` + +If `true`, the base button will have a keyboard focus ripple. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.focusRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:50 + +*** + +### focusVisibleClassName? + +> `optional` **focusVisibleClassName**: `string` + +This prop can help identify which element has keyboard focus. +The class name will be applied when the element gains the focus through keyboard interaction. +It's a polyfill for the [CSS :focus-visible selector](https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo). +The rationale for using this feature [is explained here](https://github.com/WICG/focus-visible/blob/HEAD/explainer.md). +A [polyfill can be used](https://github.com/WICG/focus-visible) to apply a `focus-visible` class to other components +if needed. + +#### Inherited from + +`Omit.focusVisibleClassName` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:59 + +*** + +### form? + +> `optional` **form**: `string` + +#### Inherited from + +`Omit.form` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3136 + +*** + +### formAction? + +> `optional` **formAction**: `string` \| (`formData`) => `void` + +#### Inherited from + +`Omit.formAction` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3137 + +*** + +### formEncType? + +> `optional` **formEncType**: `string` + +#### Inherited from + +`Omit.formEncType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3143 + +*** + +### formMethod? + +> `optional` **formMethod**: `string` + +#### Inherited from + +`Omit.formMethod` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3144 + +*** + +### formNoValidate? + +> `optional` **formNoValidate**: `boolean` + +#### Inherited from + +`Omit.formNoValidate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3145 + +*** + +### formTarget? + +> `optional` **formTarget**: `string` + +#### Inherited from + +`Omit.formTarget` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3146 + +*** + +### hidden? + +> `optional` **hidden**: `boolean` + +#### Inherited from + +`Omit.hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2902 + +*** + +### icon? + +> `optional` **icon**: `ReactNode` + +The icon to display when the component is unchecked. + +#### Default + +```ts + +``` + +#### Inherited from + +`Omit.icon` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:51 + +*** + +### id? + +> `optional` **id**: `string` + +The id of the `input` element. + +#### Inherited from + +`Omit.id` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:55 + +*** + +### indeterminate? + +> `optional` **indeterminate**: `boolean` + +If `true`, the component appears indeterminate. +This does not set the native input element to indeterminate due +to inconsistent behavior across browsers. +However, we set a `data-indeterminate` attribute on the `input`. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.indeterminate` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:63 + +*** + +### indeterminateIcon? + +> `optional` **indeterminateIcon**: `ReactNode` + +The icon to display when the component is indeterminate. + +#### Default + +```ts + +``` + +#### Inherited from + +`Omit.indeterminateIcon` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:68 + +*** + +### inert? + +> `optional` **inert**: `boolean` + +#### See + +https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert + +#### Inherited from + +`Omit.inert` + +#### Defined in + +node\_modules/@types/react/experimental.d.ts:125 + +*** + +### inlist? + +> `optional` **inlist**: `any` + +#### Inherited from + +`Omit.inlist` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2923 + +*** + +### inputMode? + +> `optional` **inputMode**: `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` + +Hints at the type of data that might be entered by the user while editing the element or its contents + +#### See + +[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) + +#### Inherited from + +`Omit.inputMode` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2951 + +*** + +### inputProps? + +> `optional` **inputProps**: `InputHTMLAttributes`\<`HTMLInputElement`\> + +[Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. + +#### Inherited from + +`Omit.inputProps` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:72 + +*** + +### inputRef? + +> `optional` **inputRef**: `Ref`\<`HTMLInputElement`\> + +Pass a ref to the `input` element. + +#### Inherited from + +`Omit.inputRef` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:76 + +*** + +### is? + +> `optional` **is**: `string` + +Specify that a standard HTML element should behave like a defined custom built-in element + +#### See + +[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) + +#### Inherited from + +`Omit.is` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2956 + +*** + +### itemID? + +> `optional` **itemID**: `string` + +#### Inherited from + +`Omit.itemID` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2940 + +*** + +### itemProp? + +> `optional` **itemProp**: `string` + +#### Inherited from + +`Omit.itemProp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2937 + +*** + +### itemRef? + +> `optional` **itemRef**: `string` + +#### Inherited from + +`Omit.itemRef` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2941 + +*** + +### itemScope? + +> `optional` **itemScope**: `boolean` + +#### Inherited from + +`Omit.itemScope` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2938 + +*** + +### itemType? + +> `optional` **itemType**: `string` + +#### Inherited from + +`Omit.itemType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2939 + +*** + +### key? + +> `optional` **key**: `null` \| `Key` + +#### Inherited from + +`Omit.key` + +#### Defined in + +node\_modules/@types/react/index.d.ts:261 + +*** + +### label + +> **label**: `string` + +#### Defined in + +[src/types/Checkbox.types.d.ts:6](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L6) + +*** + +### labelPlacement? + +> `optional` **labelPlacement**: `"top"` \| `"bottom"` \| `"end"` \| `"start"` + +#### Defined in + +[src/types/Checkbox.types.d.ts:9](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L9) + +*** + +### lang? + +> `optional` **lang**: `string` + +#### Inherited from + +`Omit.lang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2904 + +*** + +### LinkComponent? + +> `optional` **LinkComponent**: `ElementType`\<`any`, keyof IntrinsicElements\> + +The component used to render a link when the `href` prop is provided. + +#### Default + +```ts +'a' +``` + +#### Inherited from + +`Omit.LinkComponent` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:64 + +*** + +### name? + +> `optional` **name**: `string` + +Name attribute of the `input` element. + +#### Inherited from + +`Omit.name` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:60 + +*** + +### nonce? + +> `optional` **nonce**: `string` + +#### Inherited from + +`Omit.nonce` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2905 + +*** + +### onAbort? + +> `optional` **onAbort**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2439 + +*** + +### onAbortCapture? + +> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbortCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2440 + +*** + +### onAnimationEnd? + +> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2569 + +*** + +### onAnimationEndCapture? + +> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2570 + +*** + +### onAnimationIteration? + +> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIteration` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2571 + +*** + +### onAnimationIterationCapture? + +> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIterationCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2572 + +*** + +### onAnimationStart? + +> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2567 + +*** + +### onAnimationStartCapture? + +> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2568 + +*** + +### onAuxClick? + +> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2487 + +*** + +### onAuxClickCapture? + +> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2488 + +*** + +### onBeforeInput? + +> `optional` **onBeforeInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2411 + +*** + +### onBeforeInputCapture? + +> `optional` **onBeforeInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2412 + +*** + +### onBeforeToggle? + +> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:131 + +*** + +### onBlur? + +> `optional` **onBlur**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlur` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2405 + +*** + +### onBlurCapture? + +> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlurCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2406 + +*** + +### onCanPlay? + +> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2441 + +*** + +### onCanPlayCapture? + +> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2442 + +*** + +### onCanPlayThrough? + +> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThrough` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2443 + +*** + +### onCanPlayThroughCapture? + +> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThroughCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2444 + +*** + +### onChange() + +> **onChange**: (`event`) => `void` + +#### Parameters + +##### event + +`ChangeEvent`\<`HTMLInputElement`\> + +#### Returns + +`void` + +#### Defined in + +[src/types/Checkbox.types.d.ts:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L8) + +*** + +### onChangeCapture? + +> `optional` **onChangeCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2410 + +*** + +### onClick? + +> `optional` **onClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2489 + +*** + +### onClickCapture? + +> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2490 + +*** + +### onCompositionEnd? + +> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2395 + +*** + +### onCompositionEndCapture? + +> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2396 + +*** + +### onCompositionStart? + +> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2397 + +*** + +### onCompositionStartCapture? + +> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2398 + +*** + +### onCompositionUpdate? + +> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2399 + +*** + +### onCompositionUpdateCapture? + +> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2400 + +*** + +### onContextMenu? + +> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2491 + +*** + +### onContextMenuCapture? + +> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenuCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2492 + +*** + +### onCopy? + +> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2387 + +*** + +### onCopyCapture? + +> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopyCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2388 + +*** + +### onCut? + +> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2389 + +*** + +### onCutCapture? + +> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2390 + +*** + +### onDoubleClick? + +> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2493 + +*** + +### onDoubleClickCapture? + +> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2494 + +*** + +### onDrag? + +> `optional` **onDrag**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrag` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2495 + +*** + +### onDragCapture? + +> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2496 + +*** + +### onDragEnd? + +> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2497 + +*** + +### onDragEndCapture? + +> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2498 + +*** + +### onDragEnter? + +> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2499 + +*** + +### onDragEnterCapture? + +> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnterCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2500 + +*** + +### onDragExit? + +> `optional` **onDragExit**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2501 + +*** + +### onDragExitCapture? + +> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2502 + +*** + +### onDragLeave? + +> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2503 + +*** + +### onDragLeaveCapture? + +> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeaveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2504 + +*** + +### onDragOver? + +> `optional` **onDragOver**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2505 + +*** + +### onDragOverCapture? + +> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2506 + +*** + +### onDragStart? + +> `optional` **onDragStart**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2507 + +*** + +### onDragStartCapture? + +> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2508 + +*** + +### onDrop? + +> `optional` **onDrop**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrop` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2509 + +*** + +### onDropCapture? + +> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDropCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2510 + +*** + +### onDurationChange? + +> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2445 + +*** + +### onDurationChangeCapture? + +> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2446 + +*** + +### onEmptied? + +> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptied` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2447 + +*** + +### onEmptiedCapture? + +> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptiedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2448 + +*** + +### onEncrypted? + +> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncrypted` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2449 + +*** + +### onEncryptedCapture? + +> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncryptedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2450 + +*** + +### onEnded? + +> `optional` **onEnded**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEnded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2451 + +*** + +### onEndedCapture? + +> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEndedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2452 + +*** + +### onError? + +> `optional` **onError**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onError` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2425 + +*** + +### onErrorCapture? + +> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onErrorCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2426 + +*** + +### onFocus? + +> `optional` **onFocus**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2403 + +*** + +### onFocusCapture? + +> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocusCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2404 + +*** + +### onFocusVisible? + +> `optional` **onFocusVisible**: `FocusEventHandler`\<`any`\> + +Callback fired when the component is focused with a keyboard. +We trigger a `onFocus` callback too. + +#### Inherited from + +`Omit.onFocusVisible` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:69 + +*** + +### onGotPointerCapture? + +> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2553 + +*** + +### onGotPointerCaptureCapture? + +> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2554 + +*** + +### onInput? + +> `optional` **onInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2413 + +*** + +### onInputCapture? + +> `optional` **onInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2414 + +*** + +### onInvalid? + +> `optional` **onInvalid**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2419 + +*** + +### onInvalidCapture? + +> `optional` **onInvalidCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalidCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2420 + +*** + +### onKeyDown? + +> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2429 + +*** + +### onKeyDownCapture? + +> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2430 + +*** + +### ~~onKeyPress?~~ + +> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUp` or `onKeyDown` instead + +#### Inherited from + +`Omit.onKeyPress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2432 + +*** + +### ~~onKeyPressCapture?~~ + +> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUpCapture` or `onKeyDownCapture` instead + +#### Inherited from + +`Omit.onKeyPressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2434 + +*** + +### onKeyUp? + +> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2435 + +*** + +### onKeyUpCapture? + +> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2436 + +*** + +### onLoad? + +> `optional` **onLoad**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoad` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2423 + +*** + +### onLoadCapture? + +> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2424 + +*** + +### onLoadedData? + +> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedData` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2453 + +*** + +### onLoadedDataCapture? + +> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedDataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2454 + +*** + +### onLoadedMetadata? + +> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadata` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2455 + +*** + +### onLoadedMetadataCapture? + +> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2456 + +*** + +### onLoadStart? + +> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2457 + +*** + +### onLoadStartCapture? + +> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2458 + +*** + +### onLostPointerCapture? + +> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2555 + +*** + +### onLostPointerCaptureCapture? + +> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2556 + +*** + +### onMouseDown? + +> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2511 + +*** + +### onMouseDownCapture? + +> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2512 + +*** + +### onMouseEnter? + +> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2513 + +*** + +### onMouseLeave? + +> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2514 + +*** + +### onMouseMove? + +> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2515 + +*** + +### onMouseMoveCapture? + +> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2516 + +*** + +### onMouseOut? + +> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2517 + +*** + +### onMouseOutCapture? + +> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2518 + +*** + +### onMouseOver? + +> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2519 + +*** + +### onMouseOverCapture? + +> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2520 + +*** + +### onMouseUp? + +> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2521 + +*** + +### onMouseUpCapture? + +> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2522 + +*** + +### onPaste? + +> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPaste` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2391 + +*** + +### onPasteCapture? + +> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPasteCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2392 + +*** + +### onPause? + +> `optional` **onPause**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPause` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2459 + +*** + +### onPauseCapture? + +> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPauseCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2460 + +*** + +### onPlay? + +> `optional` **onPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2461 + +*** + +### onPlayCapture? + +> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2462 + +*** + +### onPlaying? + +> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlaying` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2463 + +*** + +### onPlayingCapture? + +> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2464 + +*** + +### onPointerCancel? + +> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2545 + +*** + +### onPointerCancelCapture? + +> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2546 + +*** + +### onPointerDown? + +> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2539 + +*** + +### onPointerDownCapture? + +> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2540 + +*** + +### onPointerEnter? + +> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2547 + +*** + +### onPointerLeave? + +> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2548 + +*** + +### onPointerMove? + +> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2541 + +*** + +### onPointerMoveCapture? + +> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2542 + +*** + +### onPointerOut? + +> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2551 + +*** + +### onPointerOutCapture? + +> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2552 + +*** + +### onPointerOver? + +> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2549 + +*** + +### onPointerOverCapture? + +> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2550 + +*** + +### onPointerUp? + +> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2543 + +*** + +### onPointerUpCapture? + +> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2544 + +*** + +### onProgress? + +> `optional` **onProgress**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2465 + +*** + +### onProgressCapture? + +> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2466 + +*** + +### onRateChange? + +> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2467 + +*** + +### onRateChangeCapture? + +> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2468 + +*** + +### onReset? + +> `optional` **onReset**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onReset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2415 + +*** + +### onResetCapture? + +> `optional` **onResetCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResetCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2416 + +*** + +### onResize? + +> `optional` **onResize**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2469 + +*** + +### onResizeCapture? + +> `optional` **onResizeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResizeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2470 + +*** + +### onScroll? + +> `optional` **onScroll**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScroll` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2559 + +*** + +### onScrollCapture? + +> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScrollCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2560 + +*** + +### onSeeked? + +> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2471 + +*** + +### onSeekedCapture? + +> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2472 + +*** + +### onSeeking? + +> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeking` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2473 + +*** + +### onSeekingCapture? + +> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2474 + +*** + +### onSelect? + +> `optional` **onSelect**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2525 + +*** + +### onSelectCapture? + +> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelectCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2526 + +*** + +### onStalled? + +> `optional` **onStalled**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2475 + +*** + +### onStalledCapture? + +> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalledCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2476 + +*** + +### onSubmit? + +> `optional` **onSubmit**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2417 + +*** + +### onSubmitCapture? + +> `optional` **onSubmitCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2418 + +*** + +### onSuspend? + +> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspend` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2477 + +*** + +### onSuspendCapture? + +> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspendCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2478 + +*** + +### onTimeUpdate? + +> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2479 + +*** + +### onTimeUpdateCapture? + +> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2480 + +*** + +### onToggle? + +> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:130 + +*** + +### onTouchCancel? + +> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2529 + +*** + +### onTouchCancelCapture? + +> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2530 + +*** + +### onTouchEnd? + +> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2531 + +*** + +### onTouchEndCapture? + +> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2532 + +*** + +### onTouchMove? + +> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2533 + +*** + +### onTouchMoveCapture? + +> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2534 + +*** + +### onTouchStart? + +> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2535 + +*** + +### onTouchStartCapture? + +> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2536 + +*** + +### onTransitionCancel? + +> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancel` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:116 + +*** + +### onTransitionCancelCapture? + +> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancelCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:117 + +*** + +### onTransitionEnd? + +> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2575 + +*** + +### onTransitionEndCapture? + +> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2576 + +*** + +### onTransitionRun? + +> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRun` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:118 + +*** + +### onTransitionRunCapture? + +> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRunCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:119 + +*** + +### onTransitionStart? + +> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStart` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:120 + +*** + +### onTransitionStartCapture? + +> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStartCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:121 + +*** + +### onVolumeChange? + +> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2481 + +*** + +### onVolumeChangeCapture? + +> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2482 + +*** + +### onWaiting? + +> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaiting` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2483 + +*** + +### onWaitingCapture? + +> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaitingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2484 + +*** + +### onWheel? + +> `optional` **onWheel**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2563 + +*** + +### onWheelCapture? + +> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2564 + +*** + +### popover? + +> `optional` **popover**: `""` \| `"auto"` \| `"manual"` + +#### Inherited from + +`Omit.popover` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:127 + +*** + +### popoverTarget? + +> `optional` **popoverTarget**: `string` + +#### Inherited from + +`Omit.popoverTarget` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:129 + +*** + +### popoverTargetAction? + +> `optional` **popoverTargetAction**: `"hide"` \| `"show"` \| `"toggle"` + +#### Inherited from + +`Omit.popoverTargetAction` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:128 + +*** + +### prefix? + +> `optional` **prefix**: `string` + +#### Inherited from + +`Omit.prefix` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2924 + +*** + +### property? + +> `optional` **property**: `string` + +#### Inherited from + +`Omit.property` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2925 + +*** + +### radioGroup? + +> `optional` **radioGroup**: `string` + +#### Inherited from + +`Omit.radioGroup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2914 + +*** + +### readOnly? + +> `optional` **readOnly**: `boolean` + +#### Inherited from + +`Omit.readOnly` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:69 + +*** + +### ref? + +> `optional` **ref**: `null` \| (`instance`) => `void` \| () => `VoidOrUndefinedOnly` \| `RefObject`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.ref` + +#### Defined in + +node\_modules/@types/react/index.d.ts:1619 + +*** + +### rel? + +> `optional` **rel**: `string` + +#### Inherited from + +`Omit.rel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2926 + +*** + +### required? + +> `optional` **required**: `boolean` + +If `true`, the `input` element is required. + +#### Default + +```ts +false +``` + +#### Overrides + +`Omit.required` + +#### Defined in + +[src/types/Checkbox.types.d.ts:10](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L10) + +*** + +### resource? + +> `optional` **resource**: `string` + +#### Inherited from + +`Omit.resource` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2927 + +*** + +### results? + +> `optional` **results**: `number` + +#### Inherited from + +`Omit.results` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2942 + +*** + +### rev? + +> `optional` **rev**: `string` + +#### Inherited from + +`Omit.rev` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2928 + +*** + +### role? + +> `optional` **role**: `AriaRole` + +#### Inherited from + +`Omit.role` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2917 + +*** + +### security? + +> `optional` **security**: `string` + +#### Inherited from + +`Omit.security` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2943 + +*** + +### size? + +> `optional` **size**: `OverridableStringUnion`\<`"large"` \| `"medium"` \| `"small"`, `CheckboxPropsSizeOverrides`\> + +The size of the component. +`small` is equivalent to the dense checkbox styling. + +#### Default + +```ts +'medium' +``` + +#### Inherited from + +`Omit.size` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:94 + +*** + +### slot? + +> `optional` **slot**: `string` + +#### Inherited from + +`Omit.slot` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2906 + +*** + +### spellCheck? + +> `optional` **spellCheck**: `Booleanish` + +#### Inherited from + +`Omit.spellCheck` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2907 + +*** + +### style? + +> `optional` **style**: `CSSProperties` + +#### Inherited from + +`Omit.style` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:61 + +*** + +### suppressContentEditableWarning? + +> `optional` **suppressContentEditableWarning**: `boolean` + +#### Inherited from + +`Omit.suppressContentEditableWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2891 + +*** + +### suppressHydrationWarning? + +> `optional` **suppressHydrationWarning**: `boolean` + +#### Inherited from + +`Omit.suppressHydrationWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2892 + +*** + +### sx? + +> `optional` **sx**: `SxProps`\<`Theme`\> + +The system prop that allows defining system overrides as well as additional CSS styles. + +#### Inherited from + +`Omit.sx` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:98 + +*** + +### tabIndex? + +> `optional` **tabIndex**: `number` + +#### Overrides + +`Omit.tabIndex` + +#### Defined in + +[src/types/Checkbox.types.d.ts:11](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Checkbox.types.d.ts#L11) + +*** + +### title? + +> `optional` **title**: `string` + +#### Inherited from + +`Omit.title` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2910 + +*** + +### TouchRippleProps? + +> `optional` **TouchRippleProps**: `Partial`\<`TouchRippleProps`\> + +Props applied to the `TouchRipple` element. + +#### Inherited from + +`Omit.TouchRippleProps` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:81 + +*** + +### touchRippleRef? + +> `optional` **touchRippleRef**: `Ref`\<`TouchRippleActions`\> + +A ref that points to the `TouchRipple` element. + +#### Inherited from + +`Omit.touchRippleRef` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:85 + +*** + +### translate? + +> `optional` **translate**: `"yes"` \| `"no"` + +#### Inherited from + +`Omit.translate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2911 + +*** + +### typeof? + +> `optional` **typeof**: `string` + +#### Inherited from + +`Omit.typeof` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2929 + +*** + +### unselectable? + +> `optional` **unselectable**: `"on"` \| `"off"` + +#### Inherited from + +`Omit.unselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2944 + +*** + +### value? + +> `optional` **value**: `unknown` + +The value of the component. The DOM API casts this to a string. +The browser uses "on" as the default value. + +#### Inherited from + +`Omit.value` + +#### Defined in + +node\_modules/@mui/material/Checkbox/Checkbox.d.ts:103 + +*** + +### vocab? + +> `optional` **vocab**: `string` + +#### Inherited from + +`Omit.vocab` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2930 diff --git a/docs/types/Input.types/functions/default.md b/docs/types/Input.types/functions/default.md new file mode 100644 index 0000000..16c88fe --- /dev/null +++ b/docs/types/Input.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Input.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`InputProps`](../interfaces/InputProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Input.types.d.ts:24](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L24) diff --git a/docs/types/Input.types/interfaces/InputProps.md b/docs/types/Input.types/interfaces/InputProps.md new file mode 100644 index 0000000..ac461ff --- /dev/null +++ b/docs/types/Input.types/interfaces/InputProps.md @@ -0,0 +1,4776 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Input.types](../README.md) / InputProps + +# Interface: InputProps + +## Extends + +- `Omit`\<`MuiInputProps`, `"variant"` \| `"onChange"`\> + +## Properties + +### about? + +> `optional` **about**: `string` + +#### Inherited from + +`Omit.about` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2920 + +*** + +### accessKey? + +> `optional` **accessKey**: `string` + +#### Inherited from + +`Omit.accessKey` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2895 + +*** + +### aria-activedescendant? + +> `optional` **aria-activedescendant**: `string` + +Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. + +#### Inherited from + +`Omit.aria-activedescendant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2593 + +*** + +### aria-atomic? + +> `optional` **aria-atomic**: `Booleanish` + +Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. + +#### Inherited from + +`Omit.aria-atomic` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2595 + +*** + +### aria-autocomplete? + +> `optional` **aria-autocomplete**: `"none"` \| `"inline"` \| `"both"` \| `"list"` + +Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made. + +#### Inherited from + +`Omit.aria-autocomplete` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2600 + +*** + +### aria-braillelabel? + +> `optional` **aria-braillelabel**: `string` + +Defines a string value that labels the current element, which is intended to be converted into Braille. + +#### See + +aria-label. + +#### Inherited from + +`Omit.aria-braillelabel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2606 + +*** + +### aria-brailleroledescription? + +> `optional` **aria-brailleroledescription**: `string` + +Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. + +#### See + +aria-roledescription. + +#### Inherited from + +`Omit.aria-brailleroledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2611 + +*** + +### aria-busy? + +> `optional` **aria-busy**: `Booleanish` + +#### Inherited from + +`Omit.aria-busy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2612 + +*** + +### aria-checked? + +> `optional` **aria-checked**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. + +#### See + + - aria-pressed + - aria-selected. + +#### Inherited from + +`Omit.aria-checked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2617 + +*** + +### aria-colcount? + +> `optional` **aria-colcount**: `number` + +Defines the total number of columns in a table, grid, or treegrid. + +#### See + +aria-colindex. + +#### Inherited from + +`Omit.aria-colcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2622 + +*** + +### aria-colindex? + +> `optional` **aria-colindex**: `number` + +Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. + +#### See + + - aria-colcount + - aria-colspan. + +#### Inherited from + +`Omit.aria-colindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2627 + +*** + +### aria-colindextext? + +> `optional` **aria-colindextext**: `string` + +Defines a human readable text alternative of aria-colindex. + +#### See + +aria-rowindextext. + +#### Inherited from + +`Omit.aria-colindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2632 + +*** + +### aria-colspan? + +> `optional` **aria-colspan**: `number` + +Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-colindex + - aria-rowspan. + +#### Inherited from + +`Omit.aria-colspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2637 + +*** + +### aria-controls? + +> `optional` **aria-controls**: `string` + +Identifies the element (or elements) whose contents or presence are controlled by the current element. + +#### See + +aria-owns. + +#### Inherited from + +`Omit.aria-controls` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2642 + +*** + +### aria-current? + +> `optional` **aria-current**: `boolean` \| `"time"` \| `"page"` \| `"false"` \| `"true"` \| `"step"` \| `"location"` \| `"date"` + +Indicates the element that represents the current item within a container or set of related elements. + +#### Inherited from + +`Omit.aria-current` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2644 + +*** + +### aria-describedby? + +> `optional` **aria-describedby**: `string` + +Identifies the element (or elements) that describes the object. + +#### See + +aria-labelledby + +#### Inherited from + +`Omit.aria-describedby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2649 + +*** + +### aria-description? + +> `optional` **aria-description**: `string` + +Defines a string value that describes or annotates the current element. + +#### See + +related aria-describedby. + +#### Inherited from + +`Omit.aria-description` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2654 + +*** + +### aria-details? + +> `optional` **aria-details**: `string` + +Identifies the element that provides a detailed, extended description for the object. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-details` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2659 + +*** + +### aria-disabled? + +> `optional` **aria-disabled**: `Booleanish` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +#### See + + - aria-hidden + - aria-readonly. + +#### Inherited from + +`Omit.aria-disabled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2664 + +*** + +### ~~aria-dropeffect?~~ + +> `optional` **aria-dropeffect**: `"none"` \| `"link"` \| `"copy"` \| `"move"` \| `"execute"` \| `"popup"` + +Indicates what functions can be performed when a dragged object is released on the drop target. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-dropeffect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2669 + +*** + +### aria-errormessage? + +> `optional` **aria-errormessage**: `string` + +Identifies the element that provides an error message for the object. + +#### See + + - aria-invalid + - aria-describedby. + +#### Inherited from + +`Omit.aria-errormessage` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2674 + +*** + +### aria-expanded? + +> `optional` **aria-expanded**: `Booleanish` + +Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. + +#### Inherited from + +`Omit.aria-expanded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2676 + +*** + +### aria-flowto? + +> `optional` **aria-flowto**: `string` + +Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order. + +#### Inherited from + +`Omit.aria-flowto` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2681 + +*** + +### ~~aria-grabbed?~~ + +> `optional` **aria-grabbed**: `Booleanish` + +Indicates an element's "grabbed" state in a drag-and-drop operation. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-grabbed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2686 + +*** + +### aria-haspopup? + +> `optional` **aria-haspopup**: `boolean` \| `"dialog"` \| `"menu"` \| `"grid"` \| `"listbox"` \| `"false"` \| `"true"` \| `"tree"` + +Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. + +#### Inherited from + +`Omit.aria-haspopup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2688 + +*** + +### aria-hidden? + +> `optional` **aria-hidden**: `Booleanish` + +Indicates whether the element is exposed to an accessibility API. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2693 + +*** + +### aria-invalid? + +> `optional` **aria-invalid**: `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` + +Indicates the entered value does not conform to the format expected by the application. + +#### See + +aria-errormessage. + +#### Inherited from + +`Omit.aria-invalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2698 + +*** + +### aria-keyshortcuts? + +> `optional` **aria-keyshortcuts**: `string` + +Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. + +#### Inherited from + +`Omit.aria-keyshortcuts` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2700 + +*** + +### aria-label? + +> `optional` **aria-label**: `string` + +Defines a string value that labels the current element. + +#### See + +aria-labelledby. + +#### Inherited from + +`Omit.aria-label` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2705 + +*** + +### aria-labelledby? + +> `optional` **aria-labelledby**: `string` + +Identifies the element (or elements) that labels the current element. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-labelledby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2710 + +*** + +### aria-level? + +> `optional` **aria-level**: `number` + +Defines the hierarchical level of an element within a structure. + +#### Inherited from + +`Omit.aria-level` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2712 + +*** + +### aria-live? + +> `optional` **aria-live**: `"off"` \| `"assertive"` \| `"polite"` + +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +#### Inherited from + +`Omit.aria-live` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2714 + +*** + +### aria-modal? + +> `optional` **aria-modal**: `Booleanish` + +Indicates whether an element is modal when displayed. + +#### Inherited from + +`Omit.aria-modal` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2716 + +*** + +### aria-multiline? + +> `optional` **aria-multiline**: `Booleanish` + +Indicates whether a text box accepts multiple lines of input or only a single line. + +#### Inherited from + +`Omit.aria-multiline` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2718 + +*** + +### aria-multiselectable? + +> `optional` **aria-multiselectable**: `Booleanish` + +Indicates that the user may select more than one item from the current selectable descendants. + +#### Inherited from + +`Omit.aria-multiselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2720 + +*** + +### aria-orientation? + +> `optional` **aria-orientation**: `"horizontal"` \| `"vertical"` + +Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. + +#### Inherited from + +`Omit.aria-orientation` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2722 + +*** + +### aria-owns? + +> `optional` **aria-owns**: `string` + +Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship. + +#### See + +aria-controls. + +#### Inherited from + +`Omit.aria-owns` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2728 + +*** + +### aria-placeholder? + +> `optional` **aria-placeholder**: `string` + +Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format. + +#### Inherited from + +`Omit.aria-placeholder` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2733 + +*** + +### aria-posinset? + +> `optional` **aria-posinset**: `number` + +Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-setsize. + +#### Inherited from + +`Omit.aria-posinset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2738 + +*** + +### aria-pressed? + +> `optional` **aria-pressed**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "pressed" state of toggle buttons. + +#### See + + - aria-checked + - aria-selected. + +#### Inherited from + +`Omit.aria-pressed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2743 + +*** + +### aria-readonly? + +> `optional` **aria-readonly**: `Booleanish` + +Indicates that the element is not editable, but is otherwise operable. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-readonly` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2748 + +*** + +### aria-relevant? + +> `optional` **aria-relevant**: `"text"` \| `"all"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` + +Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. + +#### See + +aria-atomic. + +#### Inherited from + +`Omit.aria-relevant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2753 + +*** + +### aria-required? + +> `optional` **aria-required**: `Booleanish` + +Indicates that user input is required on the element before a form may be submitted. + +#### Inherited from + +`Omit.aria-required` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2766 + +*** + +### aria-roledescription? + +> `optional` **aria-roledescription**: `string` + +Defines a human-readable, author-localized description for the role of an element. + +#### Inherited from + +`Omit.aria-roledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2768 + +*** + +### aria-rowcount? + +> `optional` **aria-rowcount**: `number` + +Defines the total number of rows in a table, grid, or treegrid. + +#### See + +aria-rowindex. + +#### Inherited from + +`Omit.aria-rowcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2773 + +*** + +### aria-rowindex? + +> `optional` **aria-rowindex**: `number` + +Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. + +#### See + + - aria-rowcount + - aria-rowspan. + +#### Inherited from + +`Omit.aria-rowindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2778 + +*** + +### aria-rowindextext? + +> `optional` **aria-rowindextext**: `string` + +Defines a human readable text alternative of aria-rowindex. + +#### See + +aria-colindextext. + +#### Inherited from + +`Omit.aria-rowindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2783 + +*** + +### aria-rowspan? + +> `optional` **aria-rowspan**: `number` + +Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-rowindex + - aria-colspan. + +#### Inherited from + +`Omit.aria-rowspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2788 + +*** + +### aria-selected? + +> `optional` **aria-selected**: `Booleanish` + +Indicates the current "selected" state of various widgets. + +#### See + + - aria-checked + - aria-pressed. + +#### Inherited from + +`Omit.aria-selected` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2793 + +*** + +### aria-setsize? + +> `optional` **aria-setsize**: `number` + +Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-posinset. + +#### Inherited from + +`Omit.aria-setsize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2798 + +*** + +### aria-sort? + +> `optional` **aria-sort**: `"none"` \| `"ascending"` \| `"descending"` \| `"other"` + +Indicates if items in a table or grid are sorted in ascending or descending order. + +#### Inherited from + +`Omit.aria-sort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2800 + +*** + +### aria-valuemax? + +> `optional` **aria-valuemax**: `number` + +Defines the maximum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemax` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2802 + +*** + +### aria-valuemin? + +> `optional` **aria-valuemin**: `number` + +Defines the minimum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemin` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2804 + +*** + +### aria-valuenow? + +> `optional` **aria-valuenow**: `number` + +Defines the current value for a range widget. + +#### See + +aria-valuetext. + +#### Inherited from + +`Omit.aria-valuenow` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2809 + +*** + +### aria-valuetext? + +> `optional` **aria-valuetext**: `string` + +Defines the human readable text alternative of aria-valuenow for a range widget. + +#### Inherited from + +`Omit.aria-valuetext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2811 + +*** + +### ariaLabel? + +> `optional` **ariaLabel**: `string` + +#### Defined in + +[src/types/Input.types.d.ts:20](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L20) + +*** + +### ariaLabelledBy? + +> `optional` **ariaLabelledBy**: `string` + +#### Defined in + +[src/types/Input.types.d.ts:21](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L21) + +*** + +### autoCapitalize? + +> `optional` **autoCapitalize**: `string` + +#### Inherited from + +`Omit.autoCapitalize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2933 + +*** + +### autoComplete? + +> `optional` **autoComplete**: `string` + +This prop helps users to fill forms faster, especially on mobile devices. +The name can be confusing, as it's more like an autofill. +You can learn more about it [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill). + +#### Inherited from + +`Omit.autoComplete` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:70 + +*** + +### autoCorrect? + +> `optional` **autoCorrect**: `string` + +#### Inherited from + +`Omit.autoCorrect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2934 + +*** + +### autoFocus? + +> `optional` **autoFocus**: `boolean` + +If `true`, the `input` element is focused during the first mount. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.autoFocus` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:75 + +*** + +### autoSave? + +> `optional` **autoSave**: `string` + +#### Inherited from + +`Omit.autoSave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2935 + +*** + +### classes? + +> `optional` **classes**: `Partial`\<`TextFieldClasses`\> + +Override or extend the styles applied to the component. + +#### Inherited from + +`Omit.classes` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:83 + +*** + +### className? + +> `optional` **className**: `string` + +#### Inherited from + +`Omit.className` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:60 + +*** + +### color? + +> `optional` **color**: `OverridableStringUnion`\<`"primary"` \| `"secondary"` \| `"error"` \| `"success"` \| `"info"` \| `"warning"`, `TextFieldPropsColorOverrides`\> + +The color of the component. +It supports both default and custom theme colors, which can be added as shown in the +[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors). + +#### Default + +```ts +'primary' +``` + +#### Inherited from + +`Omit.color` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:90 + +*** + +### component? + +> `optional` **component**: `ElementType`\<`any`, keyof IntrinsicElements\> + +#### Inherited from + +`Omit.component` + +#### Defined in + +node\_modules/@mui/material/FormControl/FormControl.d.ts:131 + +*** + +### content? + +> `optional` **content**: `string` + +#### Inherited from + +`Omit.content` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2921 + +*** + +### contentEditable? + +> `optional` **contentEditable**: `"inherit"` \| `Booleanish` \| `"plaintext-only"` + +#### Inherited from + +`Omit.contentEditable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2898 + +*** + +### contextMenu? + +> `optional` **contextMenu**: `string` + +#### Inherited from + +`Omit.contextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2899 + +*** + +### dangerouslySetInnerHTML? + +> `optional` **dangerouslySetInnerHTML**: `object` + +#### \_\_html + +> **\_\_html**: `string` \| `TrustedHTML` + +#### Inherited from + +`Omit.dangerouslySetInnerHTML` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2380 + +*** + +### datatype? + +> `optional` **datatype**: `string` + +#### Inherited from + +`Omit.datatype` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2922 + +*** + +### defaultChecked? + +> `optional` **defaultChecked**: `boolean` + +#### Inherited from + +`Omit.defaultChecked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2889 + +*** + +### defaultValue? + +> `optional` **defaultValue**: `unknown` + +The default value. Use when the component is not controlled. + +#### Inherited from + +`Omit.defaultValue` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:97 + +*** + +### dir? + +> `optional` **dir**: `string` + +#### Inherited from + +`Omit.dir` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2900 + +*** + +### disabled? + +> `optional` **disabled**: `boolean` + +If `true`, the component is disabled. + +#### Default + +```ts +false +``` + +#### Overrides + +`Omit.disabled` + +#### Defined in + +[src/types/Input.types.d.ts:15](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L15) + +*** + +### draggable? + +> `optional` **draggable**: `Booleanish` + +#### Inherited from + +`Omit.draggable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2901 + +*** + +### error? + +> `optional` **error**: `boolean` + +If `true`, the label is displayed in an error state. + +#### Default + +```ts +false +``` + +#### Overrides + +`Omit.error` + +#### Defined in + +[src/types/Input.types.d.ts:14](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L14) + +*** + +### focused? + +> `optional` **focused**: `boolean` + +If `true`, the component is displayed in focused state. + +#### Inherited from + +`Omit.focused` + +#### Defined in + +node\_modules/@mui/material/FormControl/FormControl.d.ts:48 + +*** + +### ~~FormHelperTextProps?~~ + +> `optional` **FormHelperTextProps**: `Partial`\<`FormHelperTextProps`\> + +Props applied to the [`FormHelperText`](https://mui.com/material-ui/api/form-helper-text/) element. + +#### Deprecated + +Use `slotProps.formHelperText` instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.FormHelperTextProps` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:112 + +*** + +### fullWidth? + +> `optional` **fullWidth**: `boolean` + +If `true`, the input will take up the full width of its container. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.fullWidth` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:117 + +*** + +### helperText? + +> `optional` **helperText**: `string` + +The helper text content. + +#### Overrides + +`Omit.helperText` + +#### Defined in + +[src/types/Input.types.d.ts:13](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L13) + +*** + +### hidden? + +> `optional` **hidden**: `boolean` + +#### Inherited from + +`Omit.hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2902 + +*** + +### hiddenLabel? + +> `optional` **hiddenLabel**: `boolean` + +If `true`, the label is hidden. +This is used to increase density for a `FilledInput`. +Be sure to add `aria-label` to the `input` element. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.hiddenLabel` + +#### Defined in + +node\_modules/@mui/material/FormControl/FormControl.d.ts:55 + +*** + +### id? + +> `optional` **id**: `string` + +The id of the `input` element. +Use this prop to make `label` and `helperText` accessible for screen readers. + +#### Inherited from + +`Omit.id` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:126 + +*** + +### inert? + +> `optional` **inert**: `boolean` + +#### See + +https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert + +#### Inherited from + +`Omit.inert` + +#### Defined in + +node\_modules/@types/react/experimental.d.ts:125 + +*** + +### inlist? + +> `optional` **inlist**: `any` + +#### Inherited from + +`Omit.inlist` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2923 + +*** + +### ~~InputLabelProps?~~ + +> `optional` **InputLabelProps**: `Partial`\<`InputLabelProps`\> + +Props applied to the [`InputLabel`](https://mui.com/material-ui/api/input-label/) element. +Pointer events like `onClick` are enabled if and only if `shrink` is `true`. + +#### Deprecated + +Use `slotProps.inputLabel` instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.InputLabelProps` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:132 + +*** + +### inputMode? + +> `optional` **inputMode**: `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` + +Hints at the type of data that might be entered by the user while editing the element or its contents + +#### See + +[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) + +#### Inherited from + +`Omit.inputMode` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2951 + +*** + +### ~~inputProps?~~ + +> `optional` **inputProps**: `InputBaseComponentProps` + +[Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. + +#### Deprecated + +Use `slotProps.htmlInput` instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.inputProps` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:137 + +*** + +### ~~InputProps?~~ + +> `optional` **InputProps**: `Partial`\<`FilledInputProps`\> \| `Partial`\<`OutlinedInputProps`\> \| `Partial`\<`InputProps`\> + +Props applied to the Input element. +It will be a [`FilledInput`](https://mui.com/material-ui/api/filled-input/), +[`OutlinedInput`](https://mui.com/material-ui/api/outlined-input/) or [`Input`](https://mui.com/material-ui/api/input/) +component depending on the `variant` prop value. + +#### Deprecated + +Use `slotProps.input` instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.InputProps` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:254 + +*** + +### inputRef? + +> `optional` **inputRef**: `Ref`\<`any`\> + +Pass a ref to the `input` element. + +#### Inherited from + +`Omit.inputRef` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:141 + +*** + +### is? + +> `optional` **is**: `string` + +Specify that a standard HTML element should behave like a defined custom built-in element + +#### See + +[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) + +#### Inherited from + +`Omit.is` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2956 + +*** + +### itemID? + +> `optional` **itemID**: `string` + +#### Inherited from + +`Omit.itemID` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2940 + +*** + +### itemProp? + +> `optional` **itemProp**: `string` + +#### Inherited from + +`Omit.itemProp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2937 + +*** + +### itemRef? + +> `optional` **itemRef**: `string` + +#### Inherited from + +`Omit.itemRef` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2941 + +*** + +### itemScope? + +> `optional` **itemScope**: `boolean` + +#### Inherited from + +`Omit.itemScope` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2938 + +*** + +### itemType? + +> `optional` **itemType**: `string` + +#### Inherited from + +`Omit.itemType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2939 + +*** + +### key? + +> `optional` **key**: `null` \| `Key` + +#### Inherited from + +`Omit.key` + +#### Defined in + +node\_modules/@types/react/index.d.ts:261 + +*** + +### label + +> **label**: `string` + +The label content. + +#### Overrides + +`Omit.label` + +#### Defined in + +[src/types/Input.types.d.ts:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L7) + +*** + +### lang? + +> `optional` **lang**: `string` + +#### Inherited from + +`Omit.lang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2904 + +*** + +### margin? + +> `optional` **margin**: `"normal"` \| `"none"` \| `"dense"` + +If `dense` or `normal`, will adjust vertical spacing of this and contained components. + +#### Default + +```ts +'none' +``` + +#### Inherited from + +`Omit.margin` + +#### Defined in + +node\_modules/@mui/material/FormControl/FormControl.d.ts:60 + +*** + +### maxRows? + +> `optional` **maxRows**: `string` \| `number` + +Maximum number of rows to display when multiline option is set to true. + +#### Inherited from + +`Omit.maxRows` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:173 + +*** + +### minRows? + +> `optional` **minRows**: `string` \| `number` + +Minimum number of rows to display when multiline option is set to true. + +#### Inherited from + +`Omit.minRows` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:177 + +*** + +### multiline? + +> `optional` **multiline**: `boolean` + +If `true`, a `textarea` element is rendered instead of an input. + +#### Default + +```ts +false +``` + +#### Overrides + +`Omit.multiline` + +#### Defined in + +[src/types/Input.types.d.ts:16](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L16) + +*** + +### name? + +> `optional` **name**: `string` + +Name attribute of the `input` element. + +#### Inherited from + +`Omit.name` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:154 + +*** + +### nonce? + +> `optional` **nonce**: `string` + +#### Inherited from + +`Omit.nonce` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2905 + +*** + +### onAbort? + +> `optional` **onAbort**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAbort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2439 + +*** + +### onAbortCapture? + +> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAbortCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2440 + +*** + +### onAnimationEnd? + +> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2569 + +*** + +### onAnimationEndCapture? + +> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2570 + +*** + +### onAnimationIteration? + +> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationIteration` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2571 + +*** + +### onAnimationIterationCapture? + +> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationIterationCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2572 + +*** + +### onAnimationStart? + +> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2567 + +*** + +### onAnimationStartCapture? + +> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAnimationStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2568 + +*** + +### onAuxClick? + +> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAuxClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2487 + +*** + +### onAuxClickCapture? + +> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onAuxClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2488 + +*** + +### onBeforeInput? + +> `optional` **onBeforeInput**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onBeforeInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2411 + +*** + +### onBeforeInputCapture? + +> `optional` **onBeforeInputCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onBeforeInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2412 + +*** + +### onBeforeToggle? + +> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onBeforeToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:131 + +*** + +### onBlur? + +> `optional` **onBlur**: `FocusEventHandler`\<`HTMLInputElement` \| `HTMLTextAreaElement`\> + +#### Inherited from + +`Omit.onBlur` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:155 + +*** + +### onBlurCapture? + +> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onBlurCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2406 + +*** + +### onCanPlay? + +> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCanPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2441 + +*** + +### onCanPlayCapture? + +> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCanPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2442 + +*** + +### onCanPlayThrough? + +> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCanPlayThrough` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2443 + +*** + +### onCanPlayThroughCapture? + +> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCanPlayThroughCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2444 + +*** + +### onChange? + +> `optional` **onChange**: `ChangeEventHandler`\<`HTMLInputElement` \| `HTMLTextAreaElement`\> + +#### Defined in + +[src/types/Input.types.d.ts:9](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L9) + +*** + +### onChangeCapture? + +> `optional` **onChangeCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2410 + +*** + +### onClick? + +> `optional` **onClick**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2489 + +*** + +### onClickCapture? + +> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2490 + +*** + +### onCompositionEnd? + +> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2395 + +*** + +### onCompositionEndCapture? + +> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2396 + +*** + +### onCompositionStart? + +> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2397 + +*** + +### onCompositionStartCapture? + +> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2398 + +*** + +### onCompositionUpdate? + +> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2399 + +*** + +### onCompositionUpdateCapture? + +> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCompositionUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2400 + +*** + +### onContextMenu? + +> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onContextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2491 + +*** + +### onContextMenuCapture? + +> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onContextMenuCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2492 + +*** + +### onCopy? + +> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCopy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2387 + +*** + +### onCopyCapture? + +> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCopyCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2388 + +*** + +### onCut? + +> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2389 + +*** + +### onCutCapture? + +> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onCutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2390 + +*** + +### onDoubleClick? + +> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDoubleClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2493 + +*** + +### onDoubleClickCapture? + +> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDoubleClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2494 + +*** + +### onDrag? + +> `optional` **onDrag**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDrag` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2495 + +*** + +### onDragCapture? + +> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2496 + +*** + +### onDragEnd? + +> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2497 + +*** + +### onDragEndCapture? + +> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2498 + +*** + +### onDragEnter? + +> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2499 + +*** + +### onDragEnterCapture? + +> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragEnterCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2500 + +*** + +### onDragExit? + +> `optional` **onDragExit**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragExit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2501 + +*** + +### onDragExitCapture? + +> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragExitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2502 + +*** + +### onDragLeave? + +> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2503 + +*** + +### onDragLeaveCapture? + +> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragLeaveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2504 + +*** + +### onDragOver? + +> `optional` **onDragOver**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2505 + +*** + +### onDragOverCapture? + +> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2506 + +*** + +### onDragStart? + +> `optional` **onDragStart**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2507 + +*** + +### onDragStartCapture? + +> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDragStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2508 + +*** + +### onDrop? + +> `optional` **onDrop**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDrop` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2509 + +*** + +### onDropCapture? + +> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDropCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2510 + +*** + +### onDurationChange? + +> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDurationChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2445 + +*** + +### onDurationChangeCapture? + +> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onDurationChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2446 + +*** + +### onEmptied? + +> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEmptied` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2447 + +*** + +### onEmptiedCapture? + +> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEmptiedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2448 + +*** + +### onEncrypted? + +> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEncrypted` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2449 + +*** + +### onEncryptedCapture? + +> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEncryptedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2450 + +*** + +### onEnded? + +> `optional` **onEnded**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEnded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2451 + +*** + +### onEndedCapture? + +> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onEndedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2452 + +*** + +### onError? + +> `optional` **onError**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onError` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2425 + +*** + +### onErrorCapture? + +> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onErrorCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2426 + +*** + +### onFocus? + +> `optional` **onFocus**: `FocusEventHandler`\<`HTMLInputElement` \| `HTMLTextAreaElement`\> + +#### Inherited from + +`Omit.onFocus` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:156 + +*** + +### onFocusCapture? + +> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onFocusCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2404 + +*** + +### onGotPointerCapture? + +> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onGotPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2553 + +*** + +### onGotPointerCaptureCapture? + +> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onGotPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2554 + +*** + +### onInput? + +> `optional` **onInput**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2413 + +*** + +### onInputCapture? + +> `optional` **onInputCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2414 + +*** + +### onInvalid? + +> `optional` **onInvalid**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onInvalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2419 + +*** + +### onInvalidCapture? + +> `optional` **onInvalidCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onInvalidCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2420 + +*** + +### onKeyDown? + +> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onKeyDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2429 + +*** + +### onKeyDownCapture? + +> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onKeyDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2430 + +*** + +### ~~onKeyPress?~~ + +> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Deprecated + +Use `onKeyUp` or `onKeyDown` instead + +#### Inherited from + +`Omit.onKeyPress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2432 + +*** + +### ~~onKeyPressCapture?~~ + +> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Deprecated + +Use `onKeyUpCapture` or `onKeyDownCapture` instead + +#### Inherited from + +`Omit.onKeyPressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2434 + +*** + +### onKeyUp? + +> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onKeyUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2435 + +*** + +### onKeyUpCapture? + +> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onKeyUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2436 + +*** + +### onLoad? + +> `optional` **onLoad**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoad` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2423 + +*** + +### onLoadCapture? + +> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2424 + +*** + +### onLoadedData? + +> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadedData` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2453 + +*** + +### onLoadedDataCapture? + +> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadedDataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2454 + +*** + +### onLoadedMetadata? + +> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadedMetadata` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2455 + +*** + +### onLoadedMetadataCapture? + +> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadedMetadataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2456 + +*** + +### onLoadStart? + +> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2457 + +*** + +### onLoadStartCapture? + +> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLoadStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2458 + +*** + +### onLostPointerCapture? + +> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLostPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2555 + +*** + +### onLostPointerCaptureCapture? + +> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onLostPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2556 + +*** + +### onMouseDown? + +> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2511 + +*** + +### onMouseDownCapture? + +> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2512 + +*** + +### onMouseEnter? + +> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2513 + +*** + +### onMouseLeave? + +> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2514 + +*** + +### onMouseMove? + +> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2515 + +*** + +### onMouseMoveCapture? + +> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2516 + +*** + +### onMouseOut? + +> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2517 + +*** + +### onMouseOutCapture? + +> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2518 + +*** + +### onMouseOver? + +> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2519 + +*** + +### onMouseOverCapture? + +> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2520 + +*** + +### onMouseUp? + +> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2521 + +*** + +### onMouseUpCapture? + +> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onMouseUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2522 + +*** + +### onPaste? + +> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPaste` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2391 + +*** + +### onPasteCapture? + +> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPasteCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2392 + +*** + +### onPause? + +> `optional` **onPause**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPause` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2459 + +*** + +### onPauseCapture? + +> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPauseCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2460 + +*** + +### onPlay? + +> `optional` **onPlay**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2461 + +*** + +### onPlayCapture? + +> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2462 + +*** + +### onPlaying? + +> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPlaying` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2463 + +*** + +### onPlayingCapture? + +> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPlayingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2464 + +*** + +### onPointerCancel? + +> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2545 + +*** + +### onPointerCancelCapture? + +> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2546 + +*** + +### onPointerDown? + +> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2539 + +*** + +### onPointerDownCapture? + +> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2540 + +*** + +### onPointerEnter? + +> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2547 + +*** + +### onPointerLeave? + +> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2548 + +*** + +### onPointerMove? + +> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2541 + +*** + +### onPointerMoveCapture? + +> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2542 + +*** + +### onPointerOut? + +> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2551 + +*** + +### onPointerOutCapture? + +> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2552 + +*** + +### onPointerOver? + +> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2549 + +*** + +### onPointerOverCapture? + +> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2550 + +*** + +### onPointerUp? + +> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2543 + +*** + +### onPointerUpCapture? + +> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onPointerUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2544 + +*** + +### onProgress? + +> `optional` **onProgress**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onProgress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2465 + +*** + +### onProgressCapture? + +> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onProgressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2466 + +*** + +### onRateChange? + +> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onRateChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2467 + +*** + +### onRateChangeCapture? + +> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onRateChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2468 + +*** + +### onReset? + +> `optional` **onReset**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onReset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2415 + +*** + +### onResetCapture? + +> `optional` **onResetCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onResetCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2416 + +*** + +### onResize? + +> `optional` **onResize**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onResize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2469 + +*** + +### onResizeCapture? + +> `optional` **onResizeCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onResizeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2470 + +*** + +### onScroll? + +> `optional` **onScroll**: `UIEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onScroll` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2559 + +*** + +### onScrollCapture? + +> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onScrollCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2560 + +*** + +### onSeeked? + +> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSeeked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2471 + +*** + +### onSeekedCapture? + +> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSeekedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2472 + +*** + +### onSeeking? + +> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSeeking` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2473 + +*** + +### onSeekingCapture? + +> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSeekingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2474 + +*** + +### onSelect? + +> `optional` **onSelect**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSelect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2525 + +*** + +### onSelectCapture? + +> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSelectCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2526 + +*** + +### onStalled? + +> `optional` **onStalled**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onStalled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2475 + +*** + +### onStalledCapture? + +> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onStalledCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2476 + +*** + +### onSubmit? + +> `optional` **onSubmit**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSubmit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2417 + +*** + +### onSubmitCapture? + +> `optional` **onSubmitCapture**: `FormEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSubmitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2418 + +*** + +### onSuspend? + +> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSuspend` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2477 + +*** + +### onSuspendCapture? + +> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onSuspendCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2478 + +*** + +### onTimeUpdate? + +> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTimeUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2479 + +*** + +### onTimeUpdateCapture? + +> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTimeUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2480 + +*** + +### onToggle? + +> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:130 + +*** + +### onTouchCancel? + +> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2529 + +*** + +### onTouchCancelCapture? + +> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2530 + +*** + +### onTouchEnd? + +> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2531 + +*** + +### onTouchEndCapture? + +> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2532 + +*** + +### onTouchMove? + +> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2533 + +*** + +### onTouchMoveCapture? + +> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2534 + +*** + +### onTouchStart? + +> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2535 + +*** + +### onTouchStartCapture? + +> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTouchStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2536 + +*** + +### onTransitionCancel? + +> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionCancel` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:116 + +*** + +### onTransitionCancelCapture? + +> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionCancelCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:117 + +*** + +### onTransitionEnd? + +> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2575 + +*** + +### onTransitionEndCapture? + +> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2576 + +*** + +### onTransitionRun? + +> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionRun` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:118 + +*** + +### onTransitionRunCapture? + +> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionRunCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:119 + +*** + +### onTransitionStart? + +> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionStart` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:120 + +*** + +### onTransitionStartCapture? + +> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onTransitionStartCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:121 + +*** + +### onVolumeChange? + +> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onVolumeChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2481 + +*** + +### onVolumeChangeCapture? + +> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onVolumeChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2482 + +*** + +### onWaiting? + +> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onWaiting` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2483 + +*** + +### onWaitingCapture? + +> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onWaitingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2484 + +*** + +### onWheel? + +> `optional` **onWheel**: `WheelEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onWheel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2563 + +*** + +### onWheelCapture? + +> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.onWheelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2564 + +*** + +### placeholder? + +> `optional` **placeholder**: `string` + +The short hint displayed in the `input` before the user enters a value. + +#### Overrides + +`Omit.placeholder` + +#### Defined in + +[src/types/Input.types.d.ts:12](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L12) + +*** + +### popover? + +> `optional` **popover**: `""` \| `"auto"` \| `"manual"` + +#### Inherited from + +`Omit.popover` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:127 + +*** + +### popoverTarget? + +> `optional` **popoverTarget**: `string` + +#### Inherited from + +`Omit.popoverTarget` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:129 + +*** + +### popoverTargetAction? + +> `optional` **popoverTargetAction**: `"hide"` \| `"show"` \| `"toggle"` + +#### Inherited from + +`Omit.popoverTargetAction` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:128 + +*** + +### prefix? + +> `optional` **prefix**: `string` + +#### Inherited from + +`Omit.prefix` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2924 + +*** + +### property? + +> `optional` **property**: `string` + +#### Inherited from + +`Omit.property` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2925 + +*** + +### radioGroup? + +> `optional` **radioGroup**: `string` + +#### Inherited from + +`Omit.radioGroup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2914 + +*** + +### ref? + +> `optional` **ref**: `null` \| (`instance`) => `void` \| () => `VoidOrUndefinedOnly` \| `RefObject`\<`HTMLDivElement`\> + +#### Inherited from + +`Omit.ref` + +#### Defined in + +node\_modules/@types/react/index.d.ts:1619 + +*** + +### rel? + +> `optional` **rel**: `string` + +#### Inherited from + +`Omit.rel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2926 + +*** + +### required? + +> `optional` **required**: `boolean` + +If `true`, the label is displayed as required and the `input` element is required. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.required` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:165 + +*** + +### resource? + +> `optional` **resource**: `string` + +#### Inherited from + +`Omit.resource` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2927 + +*** + +### results? + +> `optional` **results**: `number` + +#### Inherited from + +`Omit.results` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2942 + +*** + +### rev? + +> `optional` **rev**: `string` + +#### Inherited from + +`Omit.rev` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2928 + +*** + +### role? + +> `optional` **role**: `AriaRole` + +#### Inherited from + +`Omit.role` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2917 + +*** + +### rows? + +> `optional` **rows**: `number` + +Number of rows to display when multiline option is set to true. + +#### Overrides + +`Omit.rows` + +#### Defined in + +[src/types/Input.types.d.ts:17](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L17) + +*** + +### security? + +> `optional` **security**: `string` + +#### Inherited from + +`Omit.security` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2943 + +*** + +### select? + +> `optional` **select**: `boolean` + +Render a [`Select`](https://mui.com/material-ui/api/select/) element while passing the Input element to `Select` as `input` parameter. +If this option is set you must pass the options of the select as children. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.select` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:183 + +*** + +### ~~SelectProps?~~ + +> `optional` **SelectProps**: `Partial`\<`SelectProps`\> + +Props applied to the [`Select`](https://mui.com/material-ui/api/select/) element. + +#### Deprecated + +Use `slotProps.select` instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.SelectProps` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:188 + +*** + +### size? + +> `optional` **size**: `OverridableStringUnion`\<`"medium"` \| `"small"`, `TextFieldPropsSizeOverrides`\> + +The size of the component. + +#### Inherited from + +`Omit.size` + +#### Defined in + +node\_modules/@mui/material/TextField/TextField.d.ts:192 + +*** + +### slot? + +> `optional` **slot**: `string` + +#### Inherited from + +`Omit.slot` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2906 + +*** + +### slotProps? + +> `optional` **slotProps**: \{ `formHelperText`: `SlotProps`\<`ElementType`\<`FormHelperTextProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `htmlInput`: `SlotProps`\<`ElementType`\<`undefined` \| `InputBaseComponentProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `input`: `SlotProps`\<`ElementType`\<`FilledInputProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `inputLabel`: `SlotProps`\<`ElementType`\<`InputLabelProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `select`: `SlotProps`\<`ElementType`\<`SelectProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; \} \| \{ `formHelperText`: `SlotProps`\<`ElementType`\<`FormHelperTextProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `htmlInput`: `SlotProps`\<`ElementType`\<`undefined` \| `InputBaseComponentProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `input`: `SlotProps`\<`ElementType`\<`OutlinedInputProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `inputLabel`: `SlotProps`\<`ElementType`\<`InputLabelProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `select`: `SlotProps`\<`ElementType`\<`SelectProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; \} \| \{ `formHelperText`: `SlotProps`\<`ElementType`\<`FormHelperTextProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `htmlInput`: `SlotProps`\<`ElementType`\<`undefined` \| `InputBaseComponentProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `input`: `SlotProps`\<`ElementType`\<`InputProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `inputLabel`: `SlotProps`\<`ElementType`\<`InputLabelProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; `select`: `SlotProps`\<`ElementType`\<`SelectProps`, keyof IntrinsicElements\>, \{\}, `BaseTextFieldProps`\>; \} + +The props used for each slot inside. + +#### Default + +```ts +{} +``` + +#### Inherited from + +`Omit.slotProps` + +#### Defined in + +node\_modules/@mui/material/utils/types.d.ts:25 + +*** + +### slots? + +> `optional` **slots**: `Partial`\<`TextFieldSlots`\> + +The components used for each slot inside. + +#### Default + +```ts +{} +``` + +#### Inherited from + +`Omit.slots` + +#### Defined in + +node\_modules/@mui/material/utils/types.d.ts:20 + +*** + +### spellCheck? + +> `optional` **spellCheck**: `Booleanish` + +#### Inherited from + +`Omit.spellCheck` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2907 + +*** + +### style? + +> `optional` **style**: `CSSProperties` + +#### Inherited from + +`Omit.style` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:61 + +*** + +### suppressContentEditableWarning? + +> `optional` **suppressContentEditableWarning**: `boolean` + +#### Inherited from + +`Omit.suppressContentEditableWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2891 + +*** + +### suppressHydrationWarning? + +> `optional` **suppressHydrationWarning**: `boolean` + +#### Inherited from + +`Omit.suppressHydrationWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2892 + +*** + +### sx? + +> `optional` **sx**: `object` + +The system prop that allows defining system overrides as well as additional CSS styles. + +#### Overrides + +`Omit.sx` + +#### Defined in + +[src/types/Input.types.d.ts:18](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L18) + +*** + +### tabIndex? + +> `optional` **tabIndex**: `number` + +#### Overrides + +`Omit.tabIndex` + +#### Defined in + +[src/types/Input.types.d.ts:19](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L19) + +*** + +### title? + +> `optional` **title**: `string` + +#### Inherited from + +`Omit.title` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2910 + +*** + +### translate? + +> `optional` **translate**: `"yes"` \| `"no"` + +#### Inherited from + +`Omit.translate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2911 + +*** + +### type? + +> `optional` **type**: `string` + +Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types). + +#### Overrides + +`Omit.type` + +#### Defined in + +[src/types/Input.types.d.ts:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L8) + +*** + +### typeof? + +> `optional` **typeof**: `string` + +#### Inherited from + +`Omit.typeof` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2929 + +*** + +### unselectable? + +> `optional` **unselectable**: `"on"` \| `"off"` + +#### Inherited from + +`Omit.unselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2944 + +*** + +### value? + +> `optional` **value**: `string` \| `number` + +The value of the `input` element, required for a controlled component. + +#### Overrides + +`Omit.value` + +#### Defined in + +[src/types/Input.types.d.ts:10](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L10) + +*** + +### variant? + +> `optional` **variant**: `"filled"` \| `"outlined"` \| `"standard"` + +#### Defined in + +[src/types/Input.types.d.ts:11](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Input.types.d.ts#L11) + +*** + +### vocab? + +> `optional` **vocab**: `string` + +#### Inherited from + +`Omit.vocab` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2930 diff --git a/docs/types/Link.types/functions/default.md b/docs/types/Link.types/functions/default.md new file mode 100644 index 0000000..b90fa71 --- /dev/null +++ b/docs/types/Link.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Link.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`LinkProps`](../interfaces/LinkProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Link.types.d.ts:47](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L47) diff --git a/docs/types/Link.types/interfaces/LinkProps.md b/docs/types/Link.types/interfaces/LinkProps.md new file mode 100644 index 0000000..ea6933e --- /dev/null +++ b/docs/types/Link.types/interfaces/LinkProps.md @@ -0,0 +1,5504 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Link.types](../README.md) / LinkProps + +# Interface: LinkProps + +## Extends + +- `Omit`\<`MuiLinkProps`, `"color"` \| `"variant"` \| `"underline"` \| `"href"` \| `"onClick"`\> + +## Properties + +### about? + +> `optional` **about**: `string` + +#### Inherited from + +`Omit.about` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2920 + +*** + +### accessKey? + +> `optional` **accessKey**: `string` + +#### Inherited from + +`Omit.accessKey` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2895 + +*** + +### align? + +> `optional` **align**: `"inherit"` \| `"center"` \| `"right"` \| `"left"` \| `"justify"` + +Set the text-align on the component. + +#### Default + +```ts +'inherit' +``` + +#### Inherited from + +`Omit.align` + +#### Defined in + +node\_modules/@mui/material/Typography/Typography.d.ts:18 + +*** + +### alignContent? + +> `optional` **alignContent**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.alignContent` + +*** + +### alignItems? + +> `optional` **alignItems**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.alignItems` + +*** + +### alignSelf? + +> `optional` **alignSelf**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.alignSelf` + +*** + +### aria-activedescendant? + +> `optional` **aria-activedescendant**: `string` + +Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. + +#### Inherited from + +`Omit.aria-activedescendant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2593 + +*** + +### aria-atomic? + +> `optional` **aria-atomic**: `Booleanish` + +Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. + +#### Inherited from + +`Omit.aria-atomic` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2595 + +*** + +### aria-autocomplete? + +> `optional` **aria-autocomplete**: `"none"` \| `"inline"` \| `"both"` \| `"list"` + +Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made. + +#### Inherited from + +`Omit.aria-autocomplete` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2600 + +*** + +### aria-braillelabel? + +> `optional` **aria-braillelabel**: `string` + +Defines a string value that labels the current element, which is intended to be converted into Braille. + +#### See + +aria-label. + +#### Inherited from + +`Omit.aria-braillelabel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2606 + +*** + +### aria-brailleroledescription? + +> `optional` **aria-brailleroledescription**: `string` + +Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. + +#### See + +aria-roledescription. + +#### Inherited from + +`Omit.aria-brailleroledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2611 + +*** + +### aria-busy? + +> `optional` **aria-busy**: `Booleanish` + +#### Inherited from + +`Omit.aria-busy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2612 + +*** + +### aria-checked? + +> `optional` **aria-checked**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. + +#### See + + - aria-pressed + - aria-selected. + +#### Inherited from + +`Omit.aria-checked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2617 + +*** + +### aria-colcount? + +> `optional` **aria-colcount**: `number` + +Defines the total number of columns in a table, grid, or treegrid. + +#### See + +aria-colindex. + +#### Inherited from + +`Omit.aria-colcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2622 + +*** + +### aria-colindex? + +> `optional` **aria-colindex**: `number` + +Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. + +#### See + + - aria-colcount + - aria-colspan. + +#### Inherited from + +`Omit.aria-colindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2627 + +*** + +### aria-colindextext? + +> `optional` **aria-colindextext**: `string` + +Defines a human readable text alternative of aria-colindex. + +#### See + +aria-rowindextext. + +#### Inherited from + +`Omit.aria-colindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2632 + +*** + +### aria-colspan? + +> `optional` **aria-colspan**: `number` + +Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-colindex + - aria-rowspan. + +#### Inherited from + +`Omit.aria-colspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2637 + +*** + +### aria-controls? + +> `optional` **aria-controls**: `string` + +Identifies the element (or elements) whose contents or presence are controlled by the current element. + +#### See + +aria-owns. + +#### Inherited from + +`Omit.aria-controls` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2642 + +*** + +### aria-current? + +> `optional` **aria-current**: `boolean` \| `"time"` \| `"page"` \| `"false"` \| `"true"` \| `"step"` \| `"location"` \| `"date"` + +Indicates the element that represents the current item within a container or set of related elements. + +#### Inherited from + +`Omit.aria-current` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2644 + +*** + +### aria-describedby? + +> `optional` **aria-describedby**: `string` + +Identifies the element (or elements) that describes the object. + +#### See + +aria-labelledby + +#### Inherited from + +`Omit.aria-describedby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2649 + +*** + +### aria-description? + +> `optional` **aria-description**: `string` + +Defines a string value that describes or annotates the current element. + +#### See + +related aria-describedby. + +#### Inherited from + +`Omit.aria-description` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2654 + +*** + +### aria-details? + +> `optional` **aria-details**: `string` + +Identifies the element that provides a detailed, extended description for the object. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-details` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2659 + +*** + +### aria-disabled? + +> `optional` **aria-disabled**: `Booleanish` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +#### See + + - aria-hidden + - aria-readonly. + +#### Inherited from + +`Omit.aria-disabled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2664 + +*** + +### ~~aria-dropeffect?~~ + +> `optional` **aria-dropeffect**: `"none"` \| `"link"` \| `"copy"` \| `"move"` \| `"execute"` \| `"popup"` + +Indicates what functions can be performed when a dragged object is released on the drop target. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-dropeffect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2669 + +*** + +### aria-errormessage? + +> `optional` **aria-errormessage**: `string` + +Identifies the element that provides an error message for the object. + +#### See + + - aria-invalid + - aria-describedby. + +#### Inherited from + +`Omit.aria-errormessage` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2674 + +*** + +### aria-expanded? + +> `optional` **aria-expanded**: `Booleanish` + +Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. + +#### Inherited from + +`Omit.aria-expanded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2676 + +*** + +### aria-flowto? + +> `optional` **aria-flowto**: `string` + +Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order. + +#### Inherited from + +`Omit.aria-flowto` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2681 + +*** + +### ~~aria-grabbed?~~ + +> `optional` **aria-grabbed**: `Booleanish` + +Indicates an element's "grabbed" state in a drag-and-drop operation. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-grabbed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2686 + +*** + +### aria-haspopup? + +> `optional` **aria-haspopup**: `boolean` \| `"dialog"` \| `"menu"` \| `"grid"` \| `"listbox"` \| `"false"` \| `"true"` \| `"tree"` + +Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. + +#### Inherited from + +`Omit.aria-haspopup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2688 + +*** + +### aria-hidden? + +> `optional` **aria-hidden**: `Booleanish` + +Indicates whether the element is exposed to an accessibility API. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2693 + +*** + +### aria-invalid? + +> `optional` **aria-invalid**: `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` + +Indicates the entered value does not conform to the format expected by the application. + +#### See + +aria-errormessage. + +#### Inherited from + +`Omit.aria-invalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2698 + +*** + +### aria-keyshortcuts? + +> `optional` **aria-keyshortcuts**: `string` + +Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. + +#### Inherited from + +`Omit.aria-keyshortcuts` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2700 + +*** + +### aria-label? + +> `optional` **aria-label**: `string` + +Defines a string value that labels the current element. + +#### See + +aria-labelledby. + +#### Inherited from + +`Omit.aria-label` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2705 + +*** + +### aria-labelledby? + +> `optional` **aria-labelledby**: `string` + +Identifies the element (or elements) that labels the current element. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-labelledby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2710 + +*** + +### aria-level? + +> `optional` **aria-level**: `number` + +Defines the hierarchical level of an element within a structure. + +#### Inherited from + +`Omit.aria-level` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2712 + +*** + +### aria-live? + +> `optional` **aria-live**: `"off"` \| `"assertive"` \| `"polite"` + +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +#### Inherited from + +`Omit.aria-live` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2714 + +*** + +### aria-modal? + +> `optional` **aria-modal**: `Booleanish` + +Indicates whether an element is modal when displayed. + +#### Inherited from + +`Omit.aria-modal` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2716 + +*** + +### aria-multiline? + +> `optional` **aria-multiline**: `Booleanish` + +Indicates whether a text box accepts multiple lines of input or only a single line. + +#### Inherited from + +`Omit.aria-multiline` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2718 + +*** + +### aria-multiselectable? + +> `optional` **aria-multiselectable**: `Booleanish` + +Indicates that the user may select more than one item from the current selectable descendants. + +#### Inherited from + +`Omit.aria-multiselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2720 + +*** + +### aria-orientation? + +> `optional` **aria-orientation**: `"horizontal"` \| `"vertical"` + +Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. + +#### Inherited from + +`Omit.aria-orientation` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2722 + +*** + +### aria-owns? + +> `optional` **aria-owns**: `string` + +Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship. + +#### See + +aria-controls. + +#### Inherited from + +`Omit.aria-owns` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2728 + +*** + +### aria-placeholder? + +> `optional` **aria-placeholder**: `string` + +Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format. + +#### Inherited from + +`Omit.aria-placeholder` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2733 + +*** + +### aria-posinset? + +> `optional` **aria-posinset**: `number` + +Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-setsize. + +#### Inherited from + +`Omit.aria-posinset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2738 + +*** + +### aria-pressed? + +> `optional` **aria-pressed**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "pressed" state of toggle buttons. + +#### See + + - aria-checked + - aria-selected. + +#### Inherited from + +`Omit.aria-pressed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2743 + +*** + +### aria-readonly? + +> `optional` **aria-readonly**: `Booleanish` + +Indicates that the element is not editable, but is otherwise operable. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-readonly` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2748 + +*** + +### aria-relevant? + +> `optional` **aria-relevant**: `"text"` \| `"all"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` + +Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. + +#### See + +aria-atomic. + +#### Inherited from + +`Omit.aria-relevant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2753 + +*** + +### aria-required? + +> `optional` **aria-required**: `Booleanish` + +Indicates that user input is required on the element before a form may be submitted. + +#### Inherited from + +`Omit.aria-required` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2766 + +*** + +### aria-roledescription? + +> `optional` **aria-roledescription**: `string` + +Defines a human-readable, author-localized description for the role of an element. + +#### Inherited from + +`Omit.aria-roledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2768 + +*** + +### aria-rowcount? + +> `optional` **aria-rowcount**: `number` + +Defines the total number of rows in a table, grid, or treegrid. + +#### See + +aria-rowindex. + +#### Inherited from + +`Omit.aria-rowcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2773 + +*** + +### aria-rowindex? + +> `optional` **aria-rowindex**: `number` + +Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. + +#### See + + - aria-rowcount + - aria-rowspan. + +#### Inherited from + +`Omit.aria-rowindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2778 + +*** + +### aria-rowindextext? + +> `optional` **aria-rowindextext**: `string` + +Defines a human readable text alternative of aria-rowindex. + +#### See + +aria-colindextext. + +#### Inherited from + +`Omit.aria-rowindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2783 + +*** + +### aria-rowspan? + +> `optional` **aria-rowspan**: `number` + +Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-rowindex + - aria-colspan. + +#### Inherited from + +`Omit.aria-rowspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2788 + +*** + +### aria-selected? + +> `optional` **aria-selected**: `Booleanish` + +Indicates the current "selected" state of various widgets. + +#### See + + - aria-checked + - aria-pressed. + +#### Inherited from + +`Omit.aria-selected` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2793 + +*** + +### aria-setsize? + +> `optional` **aria-setsize**: `number` + +Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-posinset. + +#### Inherited from + +`Omit.aria-setsize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2798 + +*** + +### aria-sort? + +> `optional` **aria-sort**: `"none"` \| `"ascending"` \| `"descending"` \| `"other"` + +Indicates if items in a table or grid are sorted in ascending or descending order. + +#### Inherited from + +`Omit.aria-sort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2800 + +*** + +### aria-valuemax? + +> `optional` **aria-valuemax**: `number` + +Defines the maximum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemax` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2802 + +*** + +### aria-valuemin? + +> `optional` **aria-valuemin**: `number` + +Defines the minimum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemin` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2804 + +*** + +### aria-valuenow? + +> `optional` **aria-valuenow**: `number` + +Defines the current value for a range widget. + +#### See + +aria-valuetext. + +#### Inherited from + +`Omit.aria-valuenow` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2809 + +*** + +### aria-valuetext? + +> `optional` **aria-valuetext**: `string` + +Defines the human readable text alternative of aria-valuenow for a range widget. + +#### Inherited from + +`Omit.aria-valuetext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2811 + +*** + +### ariaLabel? + +> `optional` **ariaLabel**: `string` + +#### Defined in + +[src/types/Link.types.d.ts:42](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L42) + +*** + +### autoCapitalize? + +> `optional` **autoCapitalize**: `string` + +#### Inherited from + +`Omit.autoCapitalize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2933 + +*** + +### autoCorrect? + +> `optional` **autoCorrect**: `string` + +#### Inherited from + +`Omit.autoCorrect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2934 + +*** + +### autoFocus? + +> `optional` **autoFocus**: `boolean` + +#### Inherited from + +`Omit.autoFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2896 + +*** + +### autoSave? + +> `optional` **autoSave**: `string` + +#### Inherited from + +`Omit.autoSave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2935 + +*** + +### bgcolor? + +> `optional` **bgcolor**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.bgcolor` + +*** + +### border? + +> `optional` **border**: `ResponsiveStyleValue`\<`undefined` \| `number` \| `string` & `object` \| `"-moz-initial"` \| `"inherit"` \| `"initial"` \| `"revert"` \| `"revert-layer"` \| `"unset"` \| `"aliceblue"` \| `"antiquewhite"` \| `"aqua"` \| `"aquamarine"` \| `"azure"` \| `"beige"` \| `"bisque"` \| `"black"` \| `"blanchedalmond"` \| `"blue"` \| `"blueviolet"` \| `"brown"` \| `"burlywood"` \| `"cadetblue"` \| `"chartreuse"` \| `"chocolate"` \| `"coral"` \| `"cornflowerblue"` \| `"cornsilk"` \| `"crimson"` \| `"cyan"` \| `"darkblue"` \| `"darkcyan"` \| `"darkgoldenrod"` \| `"darkgray"` \| `"darkgreen"` \| `"darkgrey"` \| `"darkkhaki"` \| `"darkmagenta"` \| `"darkolivegreen"` \| `"darkorange"` \| `"darkorchid"` \| `"darkred"` \| `"darksalmon"` \| `"darkseagreen"` \| `"darkslateblue"` \| `"darkslategray"` \| `"darkslategrey"` \| `"darkturquoise"` \| `"darkviolet"` \| `"deeppink"` \| `"deepskyblue"` \| `"dimgray"` \| `"dimgrey"` \| `"dodgerblue"` \| `"firebrick"` \| `"floralwhite"` \| `"forestgreen"` \| `"fuchsia"` \| `"gainsboro"` \| `"ghostwhite"` \| `"gold"` \| `"goldenrod"` \| `"gray"` \| `"green"` \| `"greenyellow"` \| `"grey"` \| `"honeydew"` \| `"hotpink"` \| `"indianred"` \| `"indigo"` \| `"ivory"` \| `"khaki"` \| `"lavender"` \| `"lavenderblush"` \| `"lawngreen"` \| `"lemonchiffon"` \| `"lightblue"` \| `"lightcoral"` \| `"lightcyan"` \| `"lightgoldenrodyellow"` \| `"lightgray"` \| `"lightgreen"` \| `"lightgrey"` \| `"lightpink"` \| `"lightsalmon"` \| `"lightseagreen"` \| `"lightskyblue"` \| `"lightslategray"` \| `"lightslategrey"` \| `"lightsteelblue"` \| `"lightyellow"` \| `"lime"` \| `"limegreen"` \| `"linen"` \| `"magenta"` \| `"maroon"` \| `"mediumaquamarine"` \| `"mediumblue"` \| `"mediumorchid"` \| `"mediumpurple"` \| `"mediumseagreen"` \| `"mediumslateblue"` \| `"mediumspringgreen"` \| `"mediumturquoise"` \| `"mediumvioletred"` \| `"midnightblue"` \| `"mintcream"` \| `"mistyrose"` \| `"moccasin"` \| `"navajowhite"` \| `"navy"` \| `"oldlace"` \| `"olive"` \| `"olivedrab"` \| `"orange"` \| `"orangered"` \| `"orchid"` \| `"palegoldenrod"` \| `"palegreen"` \| `"paleturquoise"` \| `"palevioletred"` \| `"papayawhip"` \| `"peachpuff"` \| `"peru"` \| `"pink"` \| `"plum"` \| `"powderblue"` \| `"purple"` \| `"rebeccapurple"` \| `"red"` \| `"rosybrown"` \| `"royalblue"` \| `"saddlebrown"` \| `"salmon"` \| `"sandybrown"` \| `"seagreen"` \| `"seashell"` \| `"sienna"` \| `"silver"` \| `"skyblue"` \| `"slateblue"` \| `"slategray"` \| `"slategrey"` \| `"snow"` \| `"springgreen"` \| `"steelblue"` \| `"tan"` \| `"teal"` \| `"thistle"` \| `"tomato"` \| `"transparent"` \| `"turquoise"` \| `"violet"` \| `"wheat"` \| `"white"` \| `"whitesmoke"` \| `"yellow"` \| `"yellowgreen"` \| `"ActiveBorder"` \| `"ActiveCaption"` \| `"AppWorkspace"` \| `"Background"` \| `"ButtonFace"` \| `"ButtonHighlight"` \| `"ButtonShadow"` \| `"ButtonText"` \| `"CaptionText"` \| `"GrayText"` \| `"Highlight"` \| `"HighlightText"` \| `"InactiveBorder"` \| `"InactiveCaption"` \| `"InactiveCaptionText"` \| `"InfoBackground"` \| `"InfoText"` \| `"Menu"` \| `"MenuText"` \| `"Scrollbar"` \| `"ThreeDDarkShadow"` \| `"ThreeDFace"` \| `"ThreeDHighlight"` \| `"ThreeDLightShadow"` \| `"ThreeDShadow"` \| `"Window"` \| `"WindowFrame"` \| `"WindowText"` \| `"currentcolor"` \| `"medium"` \| `"none"` \| `"inset"` \| `"hidden"` \| `"thick"` \| `"thin"` \| `"dashed"` \| `"dotted"` \| `"double"` \| `"groove"` \| `"outset"` \| `"ridge"` \| `"solid"`\> \| (`theme`) => `ResponsiveStyleValue`\<`undefined` \| `number` \| `string` & `object` \| `"-moz-initial"` \| `"inherit"` \| `"initial"` \| `"revert"` \| `"revert-layer"` \| `"unset"` \| `"aliceblue"` \| `"antiquewhite"` \| `"aqua"` \| `"aquamarine"` \| `"azure"` \| `"beige"` \| `"bisque"` \| `"black"` \| `"blanchedalmond"` \| `"blue"` \| `"blueviolet"` \| `"brown"` \| `"burlywood"` \| `"cadetblue"` \| `"chartreuse"` \| `"chocolate"` \| `"coral"` \| `"cornflowerblue"` \| `"cornsilk"` \| `"crimson"` \| `"cyan"` \| `"darkblue"` \| `"darkcyan"` \| `"darkgoldenrod"` \| `"darkgray"` \| `"darkgreen"` \| `"darkgrey"` \| `"darkkhaki"` \| `"darkmagenta"` \| `"darkolivegreen"` \| `"darkorange"` \| `"darkorchid"` \| `"darkred"` \| `"darksalmon"` \| `"darkseagreen"` \| `"darkslateblue"` \| `"darkslategray"` \| `"darkslategrey"` \| `"darkturquoise"` \| `"darkviolet"` \| `"deeppink"` \| `"deepskyblue"` \| `"dimgray"` \| `"dimgrey"` \| `"dodgerblue"` \| `"firebrick"` \| `"floralwhite"` \| `"forestgreen"` \| `"fuchsia"` \| `"gainsboro"` \| `"ghostwhite"` \| `"gold"` \| `"goldenrod"` \| `"gray"` \| `"green"` \| `"greenyellow"` \| `"grey"` \| `"honeydew"` \| `"hotpink"` \| `"indianred"` \| `"indigo"` \| `"ivory"` \| `"khaki"` \| `"lavender"` \| `"lavenderblush"` \| `"lawngreen"` \| `"lemonchiffon"` \| `"lightblue"` \| `"lightcoral"` \| `"lightcyan"` \| `"lightgoldenrodyellow"` \| `"lightgray"` \| `"lightgreen"` \| `"lightgrey"` \| `"lightpink"` \| `"lightsalmon"` \| `"lightseagreen"` \| `"lightskyblue"` \| `"lightslategray"` \| `"lightslategrey"` \| `"lightsteelblue"` \| `"lightyellow"` \| `"lime"` \| `"limegreen"` \| `"linen"` \| `"magenta"` \| `"maroon"` \| `"mediumaquamarine"` \| `"mediumblue"` \| `"mediumorchid"` \| `"mediumpurple"` \| `"mediumseagreen"` \| `"mediumslateblue"` \| `"mediumspringgreen"` \| `"mediumturquoise"` \| `"mediumvioletred"` \| `"midnightblue"` \| `"mintcream"` \| `"mistyrose"` \| `"moccasin"` \| `"navajowhite"` \| `"navy"` \| `"oldlace"` \| `"olive"` \| `"olivedrab"` \| `"orange"` \| `"orangered"` \| `"orchid"` \| `"palegoldenrod"` \| `"palegreen"` \| `"paleturquoise"` \| `"palevioletred"` \| `"papayawhip"` \| `"peachpuff"` \| `"peru"` \| `"pink"` \| `"plum"` \| `"powderblue"` \| `"purple"` \| `"rebeccapurple"` \| `"red"` \| `"rosybrown"` \| `"royalblue"` \| `"saddlebrown"` \| `"salmon"` \| `"sandybrown"` \| `"seagreen"` \| `"seashell"` \| `"sienna"` \| `"silver"` \| `"skyblue"` \| `"slateblue"` \| `"slategray"` \| `"slategrey"` \| `"snow"` \| `"springgreen"` \| `"steelblue"` \| `"tan"` \| `"teal"` \| `"thistle"` \| `"tomato"` \| `"transparent"` \| `"turquoise"` \| `"violet"` \| `"wheat"` \| `"white"` \| `"whitesmoke"` \| `"yellow"` \| `"yellowgreen"` \| `"ActiveBorder"` \| `"ActiveCaption"` \| `"AppWorkspace"` \| `"Background"` \| `"ButtonFace"` \| `"ButtonHighlight"` \| `"ButtonShadow"` \| `"ButtonText"` \| `"CaptionText"` \| `"GrayText"` \| `"Highlight"` \| `"HighlightText"` \| `"InactiveBorder"` \| `"InactiveCaption"` \| `"InactiveCaptionText"` \| `"InfoBackground"` \| `"InfoText"` \| `"Menu"` \| `"MenuText"` \| `"Scrollbar"` \| `"ThreeDDarkShadow"` \| `"ThreeDFace"` \| `"ThreeDHighlight"` \| `"ThreeDLightShadow"` \| `"ThreeDShadow"` \| `"Window"` \| `"WindowFrame"` \| `"WindowText"` \| `"currentcolor"` \| `"medium"` \| `"none"` \| `"inset"` \| `"hidden"` \| `"thick"` \| `"thin"` \| `"dashed"` \| `"dotted"` \| `"double"` \| `"groove"` \| `"outset"` \| `"ridge"` \| `"solid"`\> + +#### Inherited from + +`Omit.border` + +*** + +### borderBottom? + +> `optional` **borderBottom**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.borderBottom` + +*** + +### borderColor? + +> `optional` **borderColor**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.borderColor` + +*** + +### borderLeft? + +> `optional` **borderLeft**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.borderLeft` + +*** + +### borderRadius? + +> `optional` **borderRadius**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.borderRadius` + +*** + +### borderRight? + +> `optional` **borderRight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.borderRight` + +*** + +### borderTop? + +> `optional` **borderTop**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.borderTop` + +*** + +### bottom? + +> `optional` **bottom**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.bottom` + +*** + +### boxShadow? + +> `optional` **boxShadow**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.boxShadow` + +*** + +### boxSizing? + +> `optional` **boxSizing**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.boxSizing` + +*** + +### children + +> **children**: `ReactNode` + +The content of the component. + +#### Overrides + +`Omit.children` + +#### Defined in + +[src/types/Link.types.d.ts:41](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L41) + +*** + +### classes? + +> `optional` **classes**: `Partial`\<`LinkClasses`\> & `Partial`\<`ClassNameMap`\<`never`\>\> + +Override or extend the styles applied to the component. + +#### Inherited from + +`Omit.classes` + +#### Defined in + +node\_modules/@mui/material/Link/Link.d.ts:17 + +*** + +### className? + +> `optional` **className**: `string` + +#### Inherited from + +`Omit.className` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:60 + +*** + +### color? + +> `optional` **color**: `"primary"` \| `"secondary"` \| `"inherit"` \| `"initial"` \| `"textPrimary"` \| `"textSecondary"` \| `"error"` + +#### Defined in + +[src/types/Link.types.d.ts:12](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L12) + +*** + +### columnGap? + +> `optional` **columnGap**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.columnGap` + +*** + +### component? + +> `optional` **component**: `ElementType` + +#### Overrides + +`Omit.component` + +#### Defined in + +[src/types/Link.types.d.ts:44](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L44) + +*** + +### content? + +> `optional` **content**: `string` + +#### Inherited from + +`Omit.content` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2921 + +*** + +### contentEditable? + +> `optional` **contentEditable**: `"inherit"` \| `Booleanish` \| `"plaintext-only"` + +#### Inherited from + +`Omit.contentEditable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2898 + +*** + +### contextMenu? + +> `optional` **contextMenu**: `string` + +#### Inherited from + +`Omit.contextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2899 + +*** + +### dangerouslySetInnerHTML? + +> `optional` **dangerouslySetInnerHTML**: `object` + +#### \_\_html + +> **\_\_html**: `string` \| `TrustedHTML` + +#### Inherited from + +`Omit.dangerouslySetInnerHTML` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2380 + +*** + +### datatype? + +> `optional` **datatype**: `string` + +#### Inherited from + +`Omit.datatype` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2922 + +*** + +### defaultChecked? + +> `optional` **defaultChecked**: `boolean` + +#### Inherited from + +`Omit.defaultChecked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2889 + +*** + +### defaultValue? + +> `optional` **defaultValue**: `string` \| `number` \| readonly `string`[] + +#### Inherited from + +`Omit.defaultValue` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2890 + +*** + +### dir? + +> `optional` **dir**: `string` + +#### Inherited from + +`Omit.dir` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2900 + +*** + +### display? + +> `optional` **display**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.display` + +*** + +### displayPrint? + +> `optional` **displayPrint**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.displayPrint` + +*** + +### download? + +> `optional` **download**: `any` + +#### Inherited from + +`Omit.download` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3101 + +*** + +### draggable? + +> `optional` **draggable**: `Booleanish` + +#### Inherited from + +`Omit.draggable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2901 + +*** + +### flex? + +> `optional` **flex**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.flex` + +*** + +### flexBasis? + +> `optional` **flexBasis**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.flexBasis` + +*** + +### flexDirection? + +> `optional` **flexDirection**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.flexDirection` + +*** + +### flexGrow? + +> `optional` **flexGrow**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.flexGrow` + +*** + +### flexShrink? + +> `optional` **flexShrink**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.flexShrink` + +*** + +### flexWrap? + +> `optional` **flexWrap**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.flexWrap` + +*** + +### fontFamily? + +> `optional` **fontFamily**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.fontFamily` + +*** + +### fontSize? + +> `optional` **fontSize**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.fontSize` + +*** + +### fontStyle? + +> `optional` **fontStyle**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.fontStyle` + +*** + +### fontWeight? + +> `optional` **fontWeight**: `ResponsiveStyleValue`\<`undefined` \| `string` \| `string` & `object` \| `number` & `object`\> \| (`theme`) => `ResponsiveStyleValue`\<`undefined` \| `string` \| `string` & `object` \| `number` & `object`\> + +#### Inherited from + +`Omit.fontWeight` + +*** + +### gap? + +> `optional` **gap**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.gap` + +*** + +### gridArea? + +> `optional` **gridArea**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.gridArea` + +*** + +### gridAutoColumns? + +> `optional` **gridAutoColumns**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.gridAutoColumns` + +*** + +### gridAutoFlow? + +> `optional` **gridAutoFlow**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.gridAutoFlow` + +*** + +### gridAutoRows? + +> `optional` **gridAutoRows**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.gridAutoRows` + +*** + +### gridColumn? + +> `optional` **gridColumn**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.gridColumn` + +*** + +### gridRow? + +> `optional` **gridRow**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.gridRow` + +*** + +### gridTemplateAreas? + +> `optional` **gridTemplateAreas**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.gridTemplateAreas` + +*** + +### gridTemplateColumns? + +> `optional` **gridTemplateColumns**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.gridTemplateColumns` + +*** + +### gridTemplateRows? + +> `optional` **gridTemplateRows**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.gridTemplateRows` + +*** + +### gutterBottom? + +> `optional` **gutterBottom**: `boolean` + +If `true`, the text will have a bottom margin. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.gutterBottom` + +#### Defined in + +node\_modules/@mui/material/Typography/Typography.d.ts:48 + +*** + +### height? + +> `optional` **height**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.height` + +*** + +### hidden? + +> `optional` **hidden**: `boolean` + +#### Inherited from + +`Omit.hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2902 + +*** + +### href? + +> `optional` **href**: `string` + +#### Defined in + +[src/types/Link.types.d.ts:11](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L11) + +*** + +### hrefLang? + +> `optional` **hrefLang**: `string` + +#### Inherited from + +`Omit.hrefLang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3103 + +*** + +### id? + +> `optional` **id**: `string` + +#### Inherited from + +`Omit.id` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2903 + +*** + +### inert? + +> `optional` **inert**: `boolean` + +#### See + +https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert + +#### Inherited from + +`Omit.inert` + +#### Defined in + +node\_modules/@types/react/experimental.d.ts:125 + +*** + +### inlist? + +> `optional` **inlist**: `any` + +#### Inherited from + +`Omit.inlist` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2923 + +*** + +### inputMode? + +> `optional` **inputMode**: `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` + +Hints at the type of data that might be entered by the user while editing the element or its contents + +#### See + +[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) + +#### Inherited from + +`Omit.inputMode` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2951 + +*** + +### is? + +> `optional` **is**: `string` + +Specify that a standard HTML element should behave like a defined custom built-in element + +#### See + +[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) + +#### Inherited from + +`Omit.is` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2956 + +*** + +### itemID? + +> `optional` **itemID**: `string` + +#### Inherited from + +`Omit.itemID` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2940 + +*** + +### itemProp? + +> `optional` **itemProp**: `string` + +#### Inherited from + +`Omit.itemProp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2937 + +*** + +### itemRef? + +> `optional` **itemRef**: `string` + +#### Inherited from + +`Omit.itemRef` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2941 + +*** + +### itemScope? + +> `optional` **itemScope**: `boolean` + +#### Inherited from + +`Omit.itemScope` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2938 + +*** + +### itemType? + +> `optional` **itemType**: `string` + +#### Inherited from + +`Omit.itemType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2939 + +*** + +### justifyContent? + +> `optional` **justifyContent**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.justifyContent` + +*** + +### justifyItems? + +> `optional` **justifyItems**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.justifyItems` + +*** + +### justifySelf? + +> `optional` **justifySelf**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.justifySelf` + +*** + +### key? + +> `optional` **key**: `null` \| `Key` + +#### Inherited from + +`Omit.key` + +#### Defined in + +node\_modules/@types/react/index.d.ts:261 + +*** + +### lang? + +> `optional` **lang**: `string` + +#### Inherited from + +`Omit.lang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2904 + +*** + +### left? + +> `optional` **left**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.left` + +*** + +### letterSpacing? + +> `optional` **letterSpacing**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.letterSpacing` + +*** + +### lineHeight? + +> `optional` **lineHeight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.lineHeight` + +*** + +### m? + +> `optional` **m**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.m` + +*** + +### margin? + +> `optional` **margin**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.margin` + +*** + +### marginBlock? + +> `optional` **marginBlock**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginBlock` + +*** + +### marginBlockEnd? + +> `optional` **marginBlockEnd**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginBlockEnd` + +*** + +### marginBlockStart? + +> `optional` **marginBlockStart**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginBlockStart` + +*** + +### marginBottom? + +> `optional` **marginBottom**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginBottom` + +*** + +### marginInline? + +> `optional` **marginInline**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginInline` + +*** + +### marginInlineEnd? + +> `optional` **marginInlineEnd**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginInlineEnd` + +*** + +### marginInlineStart? + +> `optional` **marginInlineStart**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginInlineStart` + +*** + +### marginLeft? + +> `optional` **marginLeft**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginLeft` + +*** + +### marginRight? + +> `optional` **marginRight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginRight` + +*** + +### marginTop? + +> `optional` **marginTop**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginTop` + +*** + +### marginX? + +> `optional` **marginX**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginX` + +*** + +### marginY? + +> `optional` **marginY**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.marginY` + +*** + +### maxHeight? + +> `optional` **maxHeight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.maxHeight` + +*** + +### maxWidth? + +> `optional` **maxWidth**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.maxWidth` + +*** + +### mb? + +> `optional` **mb**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.mb` + +*** + +### media? + +> `optional` **media**: `string` + +#### Inherited from + +`Omit.media` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3104 + +*** + +### minHeight? + +> `optional` **minHeight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.minHeight` + +*** + +### minWidth? + +> `optional` **minWidth**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.minWidth` + +*** + +### ml? + +> `optional` **ml**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.ml` + +*** + +### mr? + +> `optional` **mr**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.mr` + +*** + +### mt? + +> `optional` **mt**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.mt` + +*** + +### mx? + +> `optional` **mx**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.mx` + +*** + +### my? + +> `optional` **my**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.my` + +*** + +### nonce? + +> `optional` **nonce**: `string` + +#### Inherited from + +`Omit.nonce` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2905 + +*** + +### noWrap? + +> `optional` **noWrap**: `boolean` + +If `true`, the text will not wrap, but instead will truncate with a text overflow ellipsis. + +Note that text overflow can only happen with block or inline-block level elements +(the element needs to have a width in order to overflow). + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.noWrap` + +#### Defined in + +node\_modules/@mui/material/Typography/Typography.d.ts:56 + +*** + +### onAbort? + +> `optional` **onAbort**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAbort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2439 + +*** + +### onAbortCapture? + +> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAbortCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2440 + +*** + +### onAnimationEnd? + +> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2569 + +*** + +### onAnimationEndCapture? + +> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2570 + +*** + +### onAnimationIteration? + +> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationIteration` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2571 + +*** + +### onAnimationIterationCapture? + +> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationIterationCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2572 + +*** + +### onAnimationStart? + +> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2567 + +*** + +### onAnimationStartCapture? + +> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAnimationStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2568 + +*** + +### onAuxClick? + +> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAuxClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2487 + +*** + +### onAuxClickCapture? + +> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onAuxClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2488 + +*** + +### onBeforeInput? + +> `optional` **onBeforeInput**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onBeforeInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2411 + +*** + +### onBeforeInputCapture? + +> `optional` **onBeforeInputCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onBeforeInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2412 + +*** + +### onBeforeToggle? + +> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onBeforeToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:131 + +*** + +### onBlur? + +> `optional` **onBlur**: `FocusEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onBlur` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2405 + +*** + +### onBlurCapture? + +> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onBlurCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2406 + +*** + +### onCanPlay? + +> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCanPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2441 + +*** + +### onCanPlayCapture? + +> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCanPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2442 + +*** + +### onCanPlayThrough? + +> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCanPlayThrough` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2443 + +*** + +### onCanPlayThroughCapture? + +> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCanPlayThroughCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2444 + +*** + +### onChange? + +> `optional` **onChange**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2409 + +*** + +### onChangeCapture? + +> `optional` **onChangeCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2410 + +*** + +### onClick? + +> `optional` **onClick**: `MouseEventHandler`\<`HTMLAnchorElement` \| `HTMLButtonElement`\> + +#### Defined in + +[src/types/Link.types.d.ts:38](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L38) + +*** + +### onClickCapture? + +> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2490 + +*** + +### onCompositionEnd? + +> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2395 + +*** + +### onCompositionEndCapture? + +> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2396 + +*** + +### onCompositionStart? + +> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2397 + +*** + +### onCompositionStartCapture? + +> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2398 + +*** + +### onCompositionUpdate? + +> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2399 + +*** + +### onCompositionUpdateCapture? + +> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCompositionUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2400 + +*** + +### onContextMenu? + +> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onContextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2491 + +*** + +### onContextMenuCapture? + +> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onContextMenuCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2492 + +*** + +### onCopy? + +> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCopy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2387 + +*** + +### onCopyCapture? + +> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCopyCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2388 + +*** + +### onCut? + +> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2389 + +*** + +### onCutCapture? + +> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onCutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2390 + +*** + +### onDoubleClick? + +> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDoubleClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2493 + +*** + +### onDoubleClickCapture? + +> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDoubleClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2494 + +*** + +### onDrag? + +> `optional` **onDrag**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDrag` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2495 + +*** + +### onDragCapture? + +> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2496 + +*** + +### onDragEnd? + +> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2497 + +*** + +### onDragEndCapture? + +> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2498 + +*** + +### onDragEnter? + +> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2499 + +*** + +### onDragEnterCapture? + +> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragEnterCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2500 + +*** + +### onDragExit? + +> `optional` **onDragExit**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragExit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2501 + +*** + +### onDragExitCapture? + +> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragExitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2502 + +*** + +### onDragLeave? + +> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2503 + +*** + +### onDragLeaveCapture? + +> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragLeaveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2504 + +*** + +### onDragOver? + +> `optional` **onDragOver**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2505 + +*** + +### onDragOverCapture? + +> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2506 + +*** + +### onDragStart? + +> `optional` **onDragStart**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2507 + +*** + +### onDragStartCapture? + +> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDragStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2508 + +*** + +### onDrop? + +> `optional` **onDrop**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDrop` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2509 + +*** + +### onDropCapture? + +> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDropCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2510 + +*** + +### onDurationChange? + +> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDurationChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2445 + +*** + +### onDurationChangeCapture? + +> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onDurationChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2446 + +*** + +### onEmptied? + +> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEmptied` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2447 + +*** + +### onEmptiedCapture? + +> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEmptiedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2448 + +*** + +### onEncrypted? + +> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEncrypted` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2449 + +*** + +### onEncryptedCapture? + +> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEncryptedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2450 + +*** + +### onEnded? + +> `optional` **onEnded**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEnded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2451 + +*** + +### onEndedCapture? + +> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onEndedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2452 + +*** + +### onError? + +> `optional` **onError**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onError` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2425 + +*** + +### onErrorCapture? + +> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onErrorCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2426 + +*** + +### onFocus? + +> `optional` **onFocus**: `FocusEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2403 + +*** + +### onFocusCapture? + +> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onFocusCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2404 + +*** + +### onGotPointerCapture? + +> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onGotPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2553 + +*** + +### onGotPointerCaptureCapture? + +> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onGotPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2554 + +*** + +### onInput? + +> `optional` **onInput**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2413 + +*** + +### onInputCapture? + +> `optional` **onInputCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2414 + +*** + +### onInvalid? + +> `optional` **onInvalid**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onInvalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2419 + +*** + +### onInvalidCapture? + +> `optional` **onInvalidCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onInvalidCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2420 + +*** + +### onKeyDown? + +> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onKeyDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2429 + +*** + +### onKeyDownCapture? + +> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onKeyDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2430 + +*** + +### ~~onKeyPress?~~ + +> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Deprecated + +Use `onKeyUp` or `onKeyDown` instead + +#### Inherited from + +`Omit.onKeyPress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2432 + +*** + +### ~~onKeyPressCapture?~~ + +> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Deprecated + +Use `onKeyUpCapture` or `onKeyDownCapture` instead + +#### Inherited from + +`Omit.onKeyPressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2434 + +*** + +### onKeyUp? + +> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onKeyUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2435 + +*** + +### onKeyUpCapture? + +> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onKeyUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2436 + +*** + +### onLoad? + +> `optional` **onLoad**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoad` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2423 + +*** + +### onLoadCapture? + +> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2424 + +*** + +### onLoadedData? + +> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadedData` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2453 + +*** + +### onLoadedDataCapture? + +> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadedDataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2454 + +*** + +### onLoadedMetadata? + +> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadedMetadata` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2455 + +*** + +### onLoadedMetadataCapture? + +> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadedMetadataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2456 + +*** + +### onLoadStart? + +> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2457 + +*** + +### onLoadStartCapture? + +> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLoadStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2458 + +*** + +### onLostPointerCapture? + +> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLostPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2555 + +*** + +### onLostPointerCaptureCapture? + +> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onLostPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2556 + +*** + +### onMouseDown? + +> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2511 + +*** + +### onMouseDownCapture? + +> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2512 + +*** + +### onMouseEnter? + +> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2513 + +*** + +### onMouseLeave? + +> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2514 + +*** + +### onMouseMove? + +> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2515 + +*** + +### onMouseMoveCapture? + +> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2516 + +*** + +### onMouseOut? + +> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2517 + +*** + +### onMouseOutCapture? + +> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2518 + +*** + +### onMouseOver? + +> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2519 + +*** + +### onMouseOverCapture? + +> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2520 + +*** + +### onMouseUp? + +> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2521 + +*** + +### onMouseUpCapture? + +> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onMouseUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2522 + +*** + +### onPaste? + +> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPaste` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2391 + +*** + +### onPasteCapture? + +> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPasteCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2392 + +*** + +### onPause? + +> `optional` **onPause**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPause` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2459 + +*** + +### onPauseCapture? + +> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPauseCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2460 + +*** + +### onPlay? + +> `optional` **onPlay**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2461 + +*** + +### onPlayCapture? + +> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2462 + +*** + +### onPlaying? + +> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPlaying` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2463 + +*** + +### onPlayingCapture? + +> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPlayingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2464 + +*** + +### onPointerCancel? + +> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2545 + +*** + +### onPointerCancelCapture? + +> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2546 + +*** + +### onPointerDown? + +> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2539 + +*** + +### onPointerDownCapture? + +> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2540 + +*** + +### onPointerEnter? + +> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2547 + +*** + +### onPointerLeave? + +> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2548 + +*** + +### onPointerMove? + +> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2541 + +*** + +### onPointerMoveCapture? + +> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2542 + +*** + +### onPointerOut? + +> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2551 + +*** + +### onPointerOutCapture? + +> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2552 + +*** + +### onPointerOver? + +> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2549 + +*** + +### onPointerOverCapture? + +> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2550 + +*** + +### onPointerUp? + +> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2543 + +*** + +### onPointerUpCapture? + +> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onPointerUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2544 + +*** + +### onProgress? + +> `optional` **onProgress**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onProgress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2465 + +*** + +### onProgressCapture? + +> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onProgressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2466 + +*** + +### onRateChange? + +> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onRateChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2467 + +*** + +### onRateChangeCapture? + +> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onRateChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2468 + +*** + +### onReset? + +> `optional` **onReset**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onReset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2415 + +*** + +### onResetCapture? + +> `optional` **onResetCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onResetCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2416 + +*** + +### onResize? + +> `optional` **onResize**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onResize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2469 + +*** + +### onResizeCapture? + +> `optional` **onResizeCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onResizeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2470 + +*** + +### onScroll? + +> `optional` **onScroll**: `UIEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onScroll` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2559 + +*** + +### onScrollCapture? + +> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onScrollCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2560 + +*** + +### onSeeked? + +> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSeeked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2471 + +*** + +### onSeekedCapture? + +> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSeekedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2472 + +*** + +### onSeeking? + +> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSeeking` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2473 + +*** + +### onSeekingCapture? + +> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSeekingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2474 + +*** + +### onSelect? + +> `optional` **onSelect**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSelect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2525 + +*** + +### onSelectCapture? + +> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSelectCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2526 + +*** + +### onStalled? + +> `optional` **onStalled**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onStalled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2475 + +*** + +### onStalledCapture? + +> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onStalledCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2476 + +*** + +### onSubmit? + +> `optional` **onSubmit**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSubmit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2417 + +*** + +### onSubmitCapture? + +> `optional` **onSubmitCapture**: `FormEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSubmitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2418 + +*** + +### onSuspend? + +> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSuspend` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2477 + +*** + +### onSuspendCapture? + +> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onSuspendCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2478 + +*** + +### onTimeUpdate? + +> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTimeUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2479 + +*** + +### onTimeUpdateCapture? + +> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTimeUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2480 + +*** + +### onToggle? + +> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:130 + +*** + +### onTouchCancel? + +> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2529 + +*** + +### onTouchCancelCapture? + +> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2530 + +*** + +### onTouchEnd? + +> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2531 + +*** + +### onTouchEndCapture? + +> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2532 + +*** + +### onTouchMove? + +> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2533 + +*** + +### onTouchMoveCapture? + +> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2534 + +*** + +### onTouchStart? + +> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2535 + +*** + +### onTouchStartCapture? + +> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTouchStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2536 + +*** + +### onTransitionCancel? + +> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionCancel` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:116 + +*** + +### onTransitionCancelCapture? + +> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionCancelCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:117 + +*** + +### onTransitionEnd? + +> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2575 + +*** + +### onTransitionEndCapture? + +> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2576 + +*** + +### onTransitionRun? + +> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionRun` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:118 + +*** + +### onTransitionRunCapture? + +> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionRunCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:119 + +*** + +### onTransitionStart? + +> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionStart` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:120 + +*** + +### onTransitionStartCapture? + +> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onTransitionStartCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:121 + +*** + +### onVolumeChange? + +> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onVolumeChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2481 + +*** + +### onVolumeChangeCapture? + +> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onVolumeChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2482 + +*** + +### onWaiting? + +> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onWaiting` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2483 + +*** + +### onWaitingCapture? + +> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onWaitingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2484 + +*** + +### onWheel? + +> `optional` **onWheel**: `WheelEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onWheel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2563 + +*** + +### onWheelCapture? + +> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.onWheelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2564 + +*** + +### order? + +> `optional` **order**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.order` + +*** + +### overflow? + +> `optional` **overflow**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.overflow` + +*** + +### p? + +> `optional` **p**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.p` + +*** + +### padding? + +> `optional` **padding**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.padding` + +*** + +### paddingBlock? + +> `optional` **paddingBlock**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingBlock` + +*** + +### paddingBlockEnd? + +> `optional` **paddingBlockEnd**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingBlockEnd` + +*** + +### paddingBlockStart? + +> `optional` **paddingBlockStart**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingBlockStart` + +*** + +### paddingBottom? + +> `optional` **paddingBottom**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingBottom` + +*** + +### paddingInline? + +> `optional` **paddingInline**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingInline` + +*** + +### paddingInlineEnd? + +> `optional` **paddingInlineEnd**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingInlineEnd` + +*** + +### paddingInlineStart? + +> `optional` **paddingInlineStart**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingInlineStart` + +*** + +### paddingLeft? + +> `optional` **paddingLeft**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingLeft` + +*** + +### paddingRight? + +> `optional` **paddingRight**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingRight` + +*** + +### paddingTop? + +> `optional` **paddingTop**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingTop` + +*** + +### paddingX? + +> `optional` **paddingX**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingX` + +*** + +### paddingY? + +> `optional` **paddingY**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.paddingY` + +*** + +### ~~paragraph?~~ + +> `optional` **paragraph**: `boolean` + +If `true`, the element will be a paragraph element. + +#### Default + +```ts +false +``` + +#### Deprecated + +Use the `component` prop instead. This prop will be removed in v7. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. + +#### Inherited from + +`Omit.paragraph` + +#### Defined in + +node\_modules/@mui/material/Typography/Typography.d.ts:62 + +*** + +### pb? + +> `optional` **pb**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.pb` + +*** + +### ping? + +> `optional` **ping**: `string` + +#### Inherited from + +`Omit.ping` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3105 + +*** + +### pl? + +> `optional` **pl**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.pl` + +*** + +### popover? + +> `optional` **popover**: `""` \| `"auto"` \| `"manual"` + +#### Inherited from + +`Omit.popover` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:127 + +*** + +### popoverTarget? + +> `optional` **popoverTarget**: `string` + +#### Inherited from + +`Omit.popoverTarget` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:129 + +*** + +### popoverTargetAction? + +> `optional` **popoverTargetAction**: `"hide"` \| `"show"` \| `"toggle"` + +#### Inherited from + +`Omit.popoverTargetAction` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:128 + +*** + +### position? + +> `optional` **position**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.position` + +*** + +### pr? + +> `optional` **pr**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.pr` + +*** + +### prefix? + +> `optional` **prefix**: `string` + +#### Inherited from + +`Omit.prefix` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2924 + +*** + +### property? + +> `optional` **property**: `string` + +#### Inherited from + +`Omit.property` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2925 + +*** + +### pt? + +> `optional` **pt**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.pt` + +*** + +### px? + +> `optional` **px**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.px` + +*** + +### py? + +> `optional` **py**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.py` + +*** + +### radioGroup? + +> `optional` **radioGroup**: `string` + +#### Inherited from + +`Omit.radioGroup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2914 + +*** + +### ref? + +> `optional` **ref**: `null` \| (`instance`) => `void` \| () => `VoidOrUndefinedOnly` \| `RefObject`\<`HTMLAnchorElement`\> + +#### Inherited from + +`Omit.ref` + +#### Defined in + +node\_modules/@types/react/index.d.ts:1619 + +*** + +### referrerPolicy? + +> `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy` + +#### Inherited from + +`Omit.referrerPolicy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3108 + +*** + +### rel? + +> `optional` **rel**: `string` + +#### Overrides + +`Omit.rel` + +#### Defined in + +[src/types/Link.types.d.ts:37](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L37) + +*** + +### resource? + +> `optional` **resource**: `string` + +#### Inherited from + +`Omit.resource` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2927 + +*** + +### results? + +> `optional` **results**: `number` + +#### Inherited from + +`Omit.results` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2942 + +*** + +### rev? + +> `optional` **rev**: `string` + +#### Inherited from + +`Omit.rev` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2928 + +*** + +### right? + +> `optional` **right**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.right` + +*** + +### role? + +> `optional` **role**: `string` + +#### Overrides + +`Omit.role` + +#### Defined in + +[src/types/Link.types.d.ts:43](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L43) + +*** + +### rowGap? + +> `optional` **rowGap**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.rowGap` + +*** + +### security? + +> `optional` **security**: `string` + +#### Inherited from + +`Omit.security` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2943 + +*** + +### slot? + +> `optional` **slot**: `string` + +#### Inherited from + +`Omit.slot` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2906 + +*** + +### spellCheck? + +> `optional` **spellCheck**: `Booleanish` + +#### Inherited from + +`Omit.spellCheck` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2907 + +*** + +### style? + +> `optional` **style**: `CSSProperties` + +#### Inherited from + +`Omit.style` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:61 + +*** + +### suppressContentEditableWarning? + +> `optional` **suppressContentEditableWarning**: `boolean` + +#### Inherited from + +`Omit.suppressContentEditableWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2891 + +*** + +### suppressHydrationWarning? + +> `optional` **suppressHydrationWarning**: `boolean` + +#### Inherited from + +`Omit.suppressHydrationWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2892 + +*** + +### sx? + +> `optional` **sx**: `SxProps`\<`Theme`\> + +The system prop that allows defining system overrides as well as additional CSS styles. + +#### Overrides + +`Omit.sx` + +#### Defined in + +[src/types/Link.types.d.ts:39](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L39) + +*** + +### tabIndex? + +> `optional` **tabIndex**: `number` + +#### Overrides + +`Omit.tabIndex` + +#### Defined in + +[src/types/Link.types.d.ts:40](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L40) + +*** + +### target? + +> `optional` **target**: `HTMLAttributeAnchorTarget` + +#### Overrides + +`Omit.target` + +#### Defined in + +[src/types/Link.types.d.ts:36](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L36) + +*** + +### textAlign? + +> `optional` **textAlign**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.textAlign` + +*** + +### textOverflow? + +> `optional` **textOverflow**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.textOverflow` + +*** + +### textTransform? + +> `optional` **textTransform**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.textTransform` + +*** + +### title? + +> `optional` **title**: `string` + +#### Inherited from + +`Omit.title` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2910 + +*** + +### top? + +> `optional` **top**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.top` + +*** + +### translate? + +> `optional` **translate**: `"yes"` \| `"no"` + +#### Inherited from + +`Omit.translate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2911 + +*** + +### type? + +> `optional` **type**: `string` + +#### Inherited from + +`Omit.type` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3107 + +*** + +### typeof? + +> `optional` **typeof**: `string` + +#### Inherited from + +`Omit.typeof` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2929 + +*** + +### typography? + +> `optional` **typography**: `ResponsiveStyleValue`\<`undefined` \| `string`\> \| (`theme`) => `ResponsiveStyleValue`\<`undefined` \| `string`\> + +#### Inherited from + +`Omit.typography` + +*** + +### TypographyClasses? + +> `optional` **TypographyClasses**: `Partial`\<`TypographyClasses`\> + +`classes` prop applied to the [`Typography`](https://mui.com/material-ui/api/typography/) element. + +#### Inherited from + +`Omit.TypographyClasses` + +#### Defined in + +node\_modules/@mui/material/Link/Link.d.ts:30 + +*** + +### underline? + +> `optional` **underline**: `"none"` \| `"hover"` \| `"always"` + +#### Defined in + +[src/types/Link.types.d.ts:20](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L20) + +*** + +### unselectable? + +> `optional` **unselectable**: `"on"` \| `"off"` + +#### Inherited from + +`Omit.unselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2944 + +*** + +### variant? + +> `optional` **variant**: `"h1"` \| `"h2"` \| `"h3"` \| `"h4"` \| `"h5"` \| `"h6"` \| `"subtitle1"` \| `"subtitle2"` \| `"body1"` \| `"body2"` \| `"caption"` \| `"button"` \| `"overline"` \| `"inherit"` + +#### Defined in + +[src/types/Link.types.d.ts:21](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Link.types.d.ts#L21) + +*** + +### variantMapping? + +> `optional` **variantMapping**: `Partial`\<`Record`\<`OverridableStringUnion`\<`Variant` \| `"inherit"`, `TypographyPropsVariantOverrides`\>, `string`\>\> + +The component maps the variant prop to a range of different HTML element types. +For instance, subtitle1 to `
`. +If you wish to change that mapping, you can provide your own. +Alternatively, you can use the `component` prop. + +#### Default + +```ts +{ + * h1: 'h1', + * h2: 'h2', + * h3: 'h3', + * h4: 'h4', + * h5: 'h5', + * h6: 'h6', + * subtitle1: 'h6', + * subtitle2: 'h6', + * body1: 'p', + * body2: 'p', + * inherit: 'p', + * } +``` + +#### Inherited from + +`Omit.variantMapping` + +#### Defined in + +node\_modules/@mui/material/Typography/Typography.d.ts:91 + +*** + +### visibility? + +> `optional` **visibility**: `ResponsiveStyleValue`\\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\\[\] \| undefined\> + +#### Inherited from + +`Omit.visibility` + +*** + +### vocab? + +> `optional` **vocab**: `string` + +#### Inherited from + +`Omit.vocab` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2930 + +*** + +### whiteSpace? + +> `optional` **whiteSpace**: `ResponsiveStyleValue`\ \| (`theme`) => `ResponsiveStyleValue`\ + +#### Inherited from + +`Omit.whiteSpace` + +*** + +### width? + +> `optional` **width**: `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> \| (`theme`) => `ResponsiveStyleValue`\ \| readonly NonNullable\ \| undefined\>\[\] \| undefined\> + +#### Inherited from + +`Omit.width` + +*** + +### zIndex? + +> `optional` **zIndex**: `ResponsiveStyleValue`\<`undefined` \| `string` \| `string` & `object` \| `number` & `object`\> \| (`theme`) => `ResponsiveStyleValue`\<`undefined` \| `string` \| `string` & `object` \| `number` & `object`\> + +#### Inherited from + +`Omit.zIndex` diff --git a/docs/types/Switch.types/functions/default.md b/docs/types/Switch.types/functions/default.md new file mode 100644 index 0000000..f9a3cbb --- /dev/null +++ b/docs/types/Switch.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Switch.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`SwitchProps`](../interfaces/SwitchProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Switch.types.d.ts:26](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L26) diff --git a/docs/types/Switch.types/interfaces/SwitchProps.md b/docs/types/Switch.types/interfaces/SwitchProps.md new file mode 100644 index 0000000..4e17cd8 --- /dev/null +++ b/docs/types/Switch.types/interfaces/SwitchProps.md @@ -0,0 +1,4751 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Switch.types](../README.md) / SwitchProps + +# Interface: SwitchProps + +## Extends + +- `Omit`\<`MuiSwitchProps`, `"color"`\> + +## Properties + +### about? + +> `optional` **about**: `string` + +#### Inherited from + +`Omit.about` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2920 + +*** + +### accessKey? + +> `optional` **accessKey**: `string` + +#### Inherited from + +`Omit.accessKey` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2895 + +*** + +### action? + +> `optional` **action**: `Ref`\<`ButtonBaseActions`\> + +A ref for imperative actions. +It currently only supports `focusVisible()` action. + +#### Inherited from + +`Omit.action` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:13 + +*** + +### aria-activedescendant? + +> `optional` **aria-activedescendant**: `string` + +Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. + +#### Inherited from + +`Omit.aria-activedescendant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2593 + +*** + +### aria-atomic? + +> `optional` **aria-atomic**: `Booleanish` + +Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. + +#### Inherited from + +`Omit.aria-atomic` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2595 + +*** + +### aria-autocomplete? + +> `optional` **aria-autocomplete**: `"none"` \| `"inline"` \| `"both"` \| `"list"` + +Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made. + +#### Inherited from + +`Omit.aria-autocomplete` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2600 + +*** + +### aria-braillelabel? + +> `optional` **aria-braillelabel**: `string` + +Defines a string value that labels the current element, which is intended to be converted into Braille. + +#### See + +aria-label. + +#### Inherited from + +`Omit.aria-braillelabel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2606 + +*** + +### aria-brailleroledescription? + +> `optional` **aria-brailleroledescription**: `string` + +Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. + +#### See + +aria-roledescription. + +#### Inherited from + +`Omit.aria-brailleroledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2611 + +*** + +### aria-busy? + +> `optional` **aria-busy**: `Booleanish` + +#### Inherited from + +`Omit.aria-busy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2612 + +*** + +### aria-checked? + +> `optional` **aria-checked**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. + +#### See + + - aria-pressed + - aria-selected. + +#### Inherited from + +`Omit.aria-checked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2617 + +*** + +### aria-colcount? + +> `optional` **aria-colcount**: `number` + +Defines the total number of columns in a table, grid, or treegrid. + +#### See + +aria-colindex. + +#### Inherited from + +`Omit.aria-colcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2622 + +*** + +### aria-colindex? + +> `optional` **aria-colindex**: `number` + +Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. + +#### See + + - aria-colcount + - aria-colspan. + +#### Inherited from + +`Omit.aria-colindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2627 + +*** + +### aria-colindextext? + +> `optional` **aria-colindextext**: `string` + +Defines a human readable text alternative of aria-colindex. + +#### See + +aria-rowindextext. + +#### Inherited from + +`Omit.aria-colindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2632 + +*** + +### aria-colspan? + +> `optional` **aria-colspan**: `number` + +Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-colindex + - aria-rowspan. + +#### Inherited from + +`Omit.aria-colspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2637 + +*** + +### aria-controls? + +> `optional` **aria-controls**: `string` + +Identifies the element (or elements) whose contents or presence are controlled by the current element. + +#### See + +aria-owns. + +#### Inherited from + +`Omit.aria-controls` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2642 + +*** + +### aria-current? + +> `optional` **aria-current**: `boolean` \| `"time"` \| `"page"` \| `"false"` \| `"true"` \| `"step"` \| `"location"` \| `"date"` + +Indicates the element that represents the current item within a container or set of related elements. + +#### Inherited from + +`Omit.aria-current` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2644 + +*** + +### aria-describedby? + +> `optional` **aria-describedby**: `string` + +Identifies the element (or elements) that describes the object. + +#### See + +aria-labelledby + +#### Inherited from + +`Omit.aria-describedby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2649 + +*** + +### aria-description? + +> `optional` **aria-description**: `string` + +Defines a string value that describes or annotates the current element. + +#### See + +related aria-describedby. + +#### Inherited from + +`Omit.aria-description` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2654 + +*** + +### aria-details? + +> `optional` **aria-details**: `string` + +Identifies the element that provides a detailed, extended description for the object. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-details` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2659 + +*** + +### aria-disabled? + +> `optional` **aria-disabled**: `Booleanish` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +#### See + + - aria-hidden + - aria-readonly. + +#### Inherited from + +`Omit.aria-disabled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2664 + +*** + +### ~~aria-dropeffect?~~ + +> `optional` **aria-dropeffect**: `"none"` \| `"link"` \| `"copy"` \| `"move"` \| `"execute"` \| `"popup"` + +Indicates what functions can be performed when a dragged object is released on the drop target. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-dropeffect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2669 + +*** + +### aria-errormessage? + +> `optional` **aria-errormessage**: `string` + +Identifies the element that provides an error message for the object. + +#### See + + - aria-invalid + - aria-describedby. + +#### Inherited from + +`Omit.aria-errormessage` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2674 + +*** + +### aria-expanded? + +> `optional` **aria-expanded**: `Booleanish` + +Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. + +#### Inherited from + +`Omit.aria-expanded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2676 + +*** + +### aria-flowto? + +> `optional` **aria-flowto**: `string` + +Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order. + +#### Inherited from + +`Omit.aria-flowto` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2681 + +*** + +### ~~aria-grabbed?~~ + +> `optional` **aria-grabbed**: `Booleanish` + +Indicates an element's "grabbed" state in a drag-and-drop operation. + +#### Deprecated + +in ARIA 1.1 + +#### Inherited from + +`Omit.aria-grabbed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2686 + +*** + +### aria-haspopup? + +> `optional` **aria-haspopup**: `boolean` \| `"dialog"` \| `"menu"` \| `"grid"` \| `"listbox"` \| `"false"` \| `"true"` \| `"tree"` + +Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. + +#### Inherited from + +`Omit.aria-haspopup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2688 + +*** + +### aria-hidden? + +> `optional` **aria-hidden**: `Booleanish` + +Indicates whether the element is exposed to an accessibility API. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2693 + +*** + +### aria-invalid? + +> `optional` **aria-invalid**: `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` + +Indicates the entered value does not conform to the format expected by the application. + +#### See + +aria-errormessage. + +#### Inherited from + +`Omit.aria-invalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2698 + +*** + +### aria-keyshortcuts? + +> `optional` **aria-keyshortcuts**: `string` + +Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. + +#### Inherited from + +`Omit.aria-keyshortcuts` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2700 + +*** + +### aria-label? + +> `optional` **aria-label**: `string` + +Defines a string value that labels the current element. + +#### See + +aria-labelledby. + +#### Inherited from + +`Omit.aria-label` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2705 + +*** + +### aria-labelledby? + +> `optional` **aria-labelledby**: `string` + +Identifies the element (or elements) that labels the current element. + +#### See + +aria-describedby. + +#### Inherited from + +`Omit.aria-labelledby` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2710 + +*** + +### aria-level? + +> `optional` **aria-level**: `number` + +Defines the hierarchical level of an element within a structure. + +#### Inherited from + +`Omit.aria-level` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2712 + +*** + +### aria-live? + +> `optional` **aria-live**: `"off"` \| `"assertive"` \| `"polite"` + +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +#### Inherited from + +`Omit.aria-live` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2714 + +*** + +### aria-modal? + +> `optional` **aria-modal**: `Booleanish` + +Indicates whether an element is modal when displayed. + +#### Inherited from + +`Omit.aria-modal` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2716 + +*** + +### aria-multiline? + +> `optional` **aria-multiline**: `Booleanish` + +Indicates whether a text box accepts multiple lines of input or only a single line. + +#### Inherited from + +`Omit.aria-multiline` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2718 + +*** + +### aria-multiselectable? + +> `optional` **aria-multiselectable**: `Booleanish` + +Indicates that the user may select more than one item from the current selectable descendants. + +#### Inherited from + +`Omit.aria-multiselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2720 + +*** + +### aria-orientation? + +> `optional` **aria-orientation**: `"horizontal"` \| `"vertical"` + +Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. + +#### Inherited from + +`Omit.aria-orientation` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2722 + +*** + +### aria-owns? + +> `optional` **aria-owns**: `string` + +Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship. + +#### See + +aria-controls. + +#### Inherited from + +`Omit.aria-owns` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2728 + +*** + +### aria-placeholder? + +> `optional` **aria-placeholder**: `string` + +Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format. + +#### Inherited from + +`Omit.aria-placeholder` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2733 + +*** + +### aria-posinset? + +> `optional` **aria-posinset**: `number` + +Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-setsize. + +#### Inherited from + +`Omit.aria-posinset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2738 + +*** + +### aria-pressed? + +> `optional` **aria-pressed**: `boolean` \| `"mixed"` \| `"false"` \| `"true"` + +Indicates the current "pressed" state of toggle buttons. + +#### See + + - aria-checked + - aria-selected. + +#### Inherited from + +`Omit.aria-pressed` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2743 + +*** + +### aria-readonly? + +> `optional` **aria-readonly**: `Booleanish` + +Indicates that the element is not editable, but is otherwise operable. + +#### See + +aria-disabled. + +#### Inherited from + +`Omit.aria-readonly` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2748 + +*** + +### aria-relevant? + +> `optional` **aria-relevant**: `"text"` \| `"all"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` + +Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. + +#### See + +aria-atomic. + +#### Inherited from + +`Omit.aria-relevant` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2753 + +*** + +### aria-required? + +> `optional` **aria-required**: `Booleanish` + +Indicates that user input is required on the element before a form may be submitted. + +#### Inherited from + +`Omit.aria-required` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2766 + +*** + +### aria-roledescription? + +> `optional` **aria-roledescription**: `string` + +Defines a human-readable, author-localized description for the role of an element. + +#### Inherited from + +`Omit.aria-roledescription` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2768 + +*** + +### aria-rowcount? + +> `optional` **aria-rowcount**: `number` + +Defines the total number of rows in a table, grid, or treegrid. + +#### See + +aria-rowindex. + +#### Inherited from + +`Omit.aria-rowcount` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2773 + +*** + +### aria-rowindex? + +> `optional` **aria-rowindex**: `number` + +Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. + +#### See + + - aria-rowcount + - aria-rowspan. + +#### Inherited from + +`Omit.aria-rowindex` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2778 + +*** + +### aria-rowindextext? + +> `optional` **aria-rowindextext**: `string` + +Defines a human readable text alternative of aria-rowindex. + +#### See + +aria-colindextext. + +#### Inherited from + +`Omit.aria-rowindextext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2783 + +*** + +### aria-rowspan? + +> `optional` **aria-rowspan**: `number` + +Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. + +#### See + + - aria-rowindex + - aria-colspan. + +#### Inherited from + +`Omit.aria-rowspan` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2788 + +*** + +### aria-selected? + +> `optional` **aria-selected**: `Booleanish` + +Indicates the current "selected" state of various widgets. + +#### See + + - aria-checked + - aria-pressed. + +#### Inherited from + +`Omit.aria-selected` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2793 + +*** + +### aria-setsize? + +> `optional` **aria-setsize**: `number` + +Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. + +#### See + +aria-posinset. + +#### Inherited from + +`Omit.aria-setsize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2798 + +*** + +### aria-sort? + +> `optional` **aria-sort**: `"none"` \| `"ascending"` \| `"descending"` \| `"other"` + +Indicates if items in a table or grid are sorted in ascending or descending order. + +#### Inherited from + +`Omit.aria-sort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2800 + +*** + +### aria-valuemax? + +> `optional` **aria-valuemax**: `number` + +Defines the maximum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemax` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2802 + +*** + +### aria-valuemin? + +> `optional` **aria-valuemin**: `number` + +Defines the minimum allowed value for a range widget. + +#### Inherited from + +`Omit.aria-valuemin` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2804 + +*** + +### aria-valuenow? + +> `optional` **aria-valuenow**: `number` + +Defines the current value for a range widget. + +#### See + +aria-valuetext. + +#### Inherited from + +`Omit.aria-valuenow` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2809 + +*** + +### aria-valuetext? + +> `optional` **aria-valuetext**: `string` + +Defines the human readable text alternative of aria-valuenow for a range widget. + +#### Inherited from + +`Omit.aria-valuetext` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2811 + +*** + +### ariaLabel? + +> `optional` **ariaLabel**: `string` + +#### Defined in + +[src/types/Switch.types.d.ts:21](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L21) + +*** + +### autoCapitalize? + +> `optional` **autoCapitalize**: `string` + +#### Inherited from + +`Omit.autoCapitalize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2933 + +*** + +### autoCorrect? + +> `optional` **autoCorrect**: `string` + +#### Inherited from + +`Omit.autoCorrect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2934 + +*** + +### autoFocus? + +> `optional` **autoFocus**: `boolean` + +#### Inherited from + +`Omit.autoFocus` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:8 + +*** + +### autoSave? + +> `optional` **autoSave**: `string` + +#### Inherited from + +`Omit.autoSave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2935 + +*** + +### centerRipple? + +> `optional` **centerRipple**: `boolean` + +If `true`, the ripples are centered. +They won't start at the cursor interaction position. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.centerRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:19 + +*** + +### checked? + +> `optional` **checked**: `boolean` + +If `true`, the component is checked. + +#### Overrides + +`Omit.checked` + +#### Defined in + +[src/types/Switch.types.d.ts:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L7) + +*** + +### checkedIcon? + +> `optional` **checkedIcon**: `ReactNode` + +The icon to display when the component is checked. + +#### Inherited from + +`Omit.checkedIcon` + +#### Defined in + +node\_modules/@mui/material/Switch/Switch.d.ts:17 + +*** + +### classes? + +> `optional` **classes**: `Partial`\<`SwitchClasses`\> + +Override or extend the styles applied to the component. + +#### Inherited from + +`Omit.classes` + +#### Defined in + +node\_modules/@mui/material/Switch/Switch.d.ts:21 + +*** + +### className? + +> `optional` **className**: `string` + +#### Inherited from + +`Omit.className` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:60 + +*** + +### color? + +> `optional` **color**: `"default"` \| `"primary"` \| `"secondary"` \| `"error"` \| `"success"` \| `"info"` \| `"warning"` + +#### Defined in + +[src/types/Switch.types.d.ts:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L8) + +*** + +### component? + +> `optional` **component**: `ElementType`\<`any`, keyof IntrinsicElements\> + +#### Inherited from + +`Omit.component` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:130 + +*** + +### content? + +> `optional` **content**: `string` + +#### Inherited from + +`Omit.content` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2921 + +*** + +### contentEditable? + +> `optional` **contentEditable**: `"inherit"` \| `Booleanish` \| `"plaintext-only"` + +#### Inherited from + +`Omit.contentEditable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2898 + +*** + +### contextMenu? + +> `optional` **contextMenu**: `string` + +#### Inherited from + +`Omit.contextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2899 + +*** + +### dangerouslySetInnerHTML? + +> `optional` **dangerouslySetInnerHTML**: `object` + +#### \_\_html + +> **\_\_html**: `string` \| `TrustedHTML` + +#### Inherited from + +`Omit.dangerouslySetInnerHTML` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2380 + +*** + +### datatype? + +> `optional` **datatype**: `string` + +#### Inherited from + +`Omit.datatype` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2922 + +*** + +### defaultChecked? + +> `optional` **defaultChecked**: `boolean` + +The default checked state. Use when the component is not controlled. + +#### Inherited from + +`Omit.defaultChecked` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:21 + +*** + +### defaultValue? + +> `optional` **defaultValue**: `string` \| `number` \| readonly `string`[] + +#### Inherited from + +`Omit.defaultValue` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2890 + +*** + +### dir? + +> `optional` **dir**: `string` + +#### Inherited from + +`Omit.dir` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2900 + +*** + +### disabled? + +> `optional` **disabled**: `boolean` + +If `true`, the component is disabled. + +#### Overrides + +`Omit.disabled` + +#### Defined in + +[src/types/Switch.types.d.ts:16](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L16) + +*** + +### disableFocusRipple? + +> `optional` **disableFocusRipple**: `boolean` + +If `true`, the keyboard focus ripple is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableFocusRipple` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:35 + +*** + +### disableRipple? + +> `optional` **disableRipple**: `boolean` + +If `true`, the ripple effect is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableRipple` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:30 + +*** + +### disableTouchRipple? + +> `optional` **disableTouchRipple**: `boolean` + +If `true`, the touch ripple effect is disabled. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.disableTouchRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:45 + +*** + +### draggable? + +> `optional` **draggable**: `Booleanish` + +#### Inherited from + +`Omit.draggable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2901 + +*** + +### edge? + +> `optional` **edge**: `false` \| `"end"` \| `"start"` + +If given, uses a negative margin to counteract the padding on one +side (this is often helpful for aligning the left or right +side of the icon with content above or below, without ruining the border +size and shape). + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.edge` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:43 + +*** + +### focusRipple? + +> `optional` **focusRipple**: `boolean` + +If `true`, the base button will have a keyboard focus ripple. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.focusRipple` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:50 + +*** + +### focusVisibleClassName? + +> `optional` **focusVisibleClassName**: `string` + +This prop can help identify which element has keyboard focus. +The class name will be applied when the element gains the focus through keyboard interaction. +It's a polyfill for the [CSS :focus-visible selector](https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo). +The rationale for using this feature [is explained here](https://github.com/WICG/focus-visible/blob/HEAD/explainer.md). +A [polyfill can be used](https://github.com/WICG/focus-visible) to apply a `focus-visible` class to other components +if needed. + +#### Inherited from + +`Omit.focusVisibleClassName` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:59 + +*** + +### form? + +> `optional` **form**: `string` + +#### Inherited from + +`Omit.form` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3136 + +*** + +### formAction? + +> `optional` **formAction**: `string` \| (`formData`) => `void` + +#### Inherited from + +`Omit.formAction` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3137 + +*** + +### formEncType? + +> `optional` **formEncType**: `string` + +#### Inherited from + +`Omit.formEncType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3143 + +*** + +### formMethod? + +> `optional` **formMethod**: `string` + +#### Inherited from + +`Omit.formMethod` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3144 + +*** + +### formNoValidate? + +> `optional` **formNoValidate**: `boolean` + +#### Inherited from + +`Omit.formNoValidate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3145 + +*** + +### formTarget? + +> `optional` **formTarget**: `string` + +#### Inherited from + +`Omit.formTarget` + +#### Defined in + +node\_modules/@types/react/index.d.ts:3146 + +*** + +### hidden? + +> `optional` **hidden**: `boolean` + +#### Inherited from + +`Omit.hidden` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2902 + +*** + +### icon? + +> `optional` **icon**: `ReactNode` + +The icon to display when the component is unchecked. + +#### Inherited from + +`Omit.icon` + +#### Defined in + +node\_modules/@mui/material/Switch/Switch.d.ts:39 + +*** + +### id? + +> `optional` **id**: `string` + +The id of the `input` element. + +#### Inherited from + +`Omit.id` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:48 + +*** + +### inert? + +> `optional` **inert**: `boolean` + +#### See + +https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert + +#### Inherited from + +`Omit.inert` + +#### Defined in + +node\_modules/@types/react/experimental.d.ts:125 + +*** + +### inlist? + +> `optional` **inlist**: `any` + +#### Inherited from + +`Omit.inlist` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2923 + +*** + +### inputMode? + +> `optional` **inputMode**: `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` + +Hints at the type of data that might be entered by the user while editing the element or its contents + +#### See + +[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) + +#### Inherited from + +`Omit.inputMode` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2951 + +*** + +### inputProps? + +> `optional` **inputProps**: `InputHTMLAttributes`\<`HTMLInputElement`\> + +[Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. + +#### Overrides + +`Omit.inputProps` + +#### Defined in + +[src/types/Switch.types.d.ts:23](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L23) + +*** + +### inputRef? + +> `optional` **inputRef**: `Ref`\<`any`\> + +Pass a ref to the `input` element. + +#### Inherited from + +`Omit.inputRef` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:56 + +*** + +### is? + +> `optional` **is**: `string` + +Specify that a standard HTML element should behave like a defined custom built-in element + +#### See + +[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) + +#### Inherited from + +`Omit.is` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2956 + +*** + +### itemID? + +> `optional` **itemID**: `string` + +#### Inherited from + +`Omit.itemID` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2940 + +*** + +### itemProp? + +> `optional` **itemProp**: `string` + +#### Inherited from + +`Omit.itemProp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2937 + +*** + +### itemRef? + +> `optional` **itemRef**: `string` + +#### Inherited from + +`Omit.itemRef` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2941 + +*** + +### itemScope? + +> `optional` **itemScope**: `boolean` + +#### Inherited from + +`Omit.itemScope` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2938 + +*** + +### itemType? + +> `optional` **itemType**: `string` + +#### Inherited from + +`Omit.itemType` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2939 + +*** + +### key? + +> `optional` **key**: `null` \| `Key` + +#### Inherited from + +`Omit.key` + +#### Defined in + +node\_modules/@types/react/index.d.ts:261 + +*** + +### lang? + +> `optional` **lang**: `string` + +#### Inherited from + +`Omit.lang` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2904 + +*** + +### LinkComponent? + +> `optional` **LinkComponent**: `ElementType`\<`any`, keyof IntrinsicElements\> + +The component used to render a link when the `href` prop is provided. + +#### Default + +```ts +'a' +``` + +#### Inherited from + +`Omit.LinkComponent` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:64 + +*** + +### name? + +> `optional` **name**: `string` + +Name attribute of the `input` element. + +#### Inherited from + +`Omit.name` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:60 + +*** + +### nonce? + +> `optional` **nonce**: `string` + +#### Inherited from + +`Omit.nonce` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2905 + +*** + +### onAbort? + +> `optional` **onAbort**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbort` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2439 + +*** + +### onAbortCapture? + +> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAbortCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2440 + +*** + +### onAnimationEnd? + +> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2569 + +*** + +### onAnimationEndCapture? + +> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2570 + +*** + +### onAnimationIteration? + +> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIteration` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2571 + +*** + +### onAnimationIterationCapture? + +> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationIterationCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2572 + +*** + +### onAnimationStart? + +> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2567 + +*** + +### onAnimationStartCapture? + +> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAnimationStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2568 + +*** + +### onAuxClick? + +> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2487 + +*** + +### onAuxClickCapture? + +> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onAuxClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2488 + +*** + +### onBeforeInput? + +> `optional` **onBeforeInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2411 + +*** + +### onBeforeInputCapture? + +> `optional` **onBeforeInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2412 + +*** + +### onBeforeToggle? + +> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBeforeToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:131 + +*** + +### onBlur? + +> `optional` **onBlur**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlur` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2405 + +*** + +### onBlurCapture? + +> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onBlurCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2406 + +*** + +### onCanPlay? + +> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2441 + +*** + +### onCanPlayCapture? + +> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2442 + +*** + +### onCanPlayThrough? + +> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThrough` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2443 + +*** + +### onCanPlayThroughCapture? + +> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCanPlayThroughCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2444 + +*** + +### onChange()? + +> `optional` **onChange**: (`event`, `checked`) => `void` + +Callback fired when the state is changed. + +#### Parameters + +##### event + +`ChangeEvent`\<`HTMLInputElement`\> + +The event source of the callback. +You can pull out the new value by accessing `event.target.value` (string). +You can pull out the new checked state by accessing `event.target.checked` (boolean). + +##### checked + +`boolean` + +#### Returns + +`void` + +#### Overrides + +`Omit.onChange` + +#### Defined in + +[src/types/Switch.types.d.ts:17](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L17) + +*** + +### onChangeCapture? + +> `optional` **onChangeCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2410 + +*** + +### onClick? + +> `optional` **onClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2489 + +*** + +### onClickCapture? + +> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2490 + +*** + +### onCompositionEnd? + +> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2395 + +*** + +### onCompositionEndCapture? + +> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2396 + +*** + +### onCompositionStart? + +> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2397 + +*** + +### onCompositionStartCapture? + +> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2398 + +*** + +### onCompositionUpdate? + +> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2399 + +*** + +### onCompositionUpdateCapture? + +> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCompositionUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2400 + +*** + +### onContextMenu? + +> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenu` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2491 + +*** + +### onContextMenuCapture? + +> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onContextMenuCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2492 + +*** + +### onCopy? + +> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopy` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2387 + +*** + +### onCopyCapture? + +> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCopyCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2388 + +*** + +### onCut? + +> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2389 + +*** + +### onCutCapture? + +> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onCutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2390 + +*** + +### onDoubleClick? + +> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClick` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2493 + +*** + +### onDoubleClickCapture? + +> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDoubleClickCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2494 + +*** + +### onDrag? + +> `optional` **onDrag**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrag` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2495 + +*** + +### onDragCapture? + +> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2496 + +*** + +### onDragEnd? + +> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2497 + +*** + +### onDragEndCapture? + +> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2498 + +*** + +### onDragEnter? + +> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2499 + +*** + +### onDragEnterCapture? + +> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragEnterCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2500 + +*** + +### onDragExit? + +> `optional` **onDragExit**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2501 + +*** + +### onDragExitCapture? + +> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragExitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2502 + +*** + +### onDragLeave? + +> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2503 + +*** + +### onDragLeaveCapture? + +> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragLeaveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2504 + +*** + +### onDragOver? + +> `optional` **onDragOver**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2505 + +*** + +### onDragOverCapture? + +> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2506 + +*** + +### onDragStart? + +> `optional` **onDragStart**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2507 + +*** + +### onDragStartCapture? + +> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDragStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2508 + +*** + +### onDrop? + +> `optional` **onDrop**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDrop` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2509 + +*** + +### onDropCapture? + +> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDropCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2510 + +*** + +### onDurationChange? + +> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2445 + +*** + +### onDurationChangeCapture? + +> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onDurationChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2446 + +*** + +### onEmptied? + +> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptied` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2447 + +*** + +### onEmptiedCapture? + +> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEmptiedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2448 + +*** + +### onEncrypted? + +> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncrypted` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2449 + +*** + +### onEncryptedCapture? + +> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEncryptedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2450 + +*** + +### onEnded? + +> `optional` **onEnded**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEnded` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2451 + +*** + +### onEndedCapture? + +> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onEndedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2452 + +*** + +### onError? + +> `optional` **onError**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onError` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2425 + +*** + +### onErrorCapture? + +> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onErrorCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2426 + +*** + +### onFocus? + +> `optional` **onFocus**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocus` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2403 + +*** + +### onFocusCapture? + +> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onFocusCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2404 + +*** + +### onFocusVisible? + +> `optional` **onFocusVisible**: `FocusEventHandler`\<`any`\> + +Callback fired when the component is focused with a keyboard. +We trigger a `onFocus` callback too. + +#### Inherited from + +`Omit.onFocusVisible` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:69 + +*** + +### onGotPointerCapture? + +> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2553 + +*** + +### onGotPointerCaptureCapture? + +> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onGotPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2554 + +*** + +### onInput? + +> `optional` **onInput**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInput` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2413 + +*** + +### onInputCapture? + +> `optional` **onInputCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInputCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2414 + +*** + +### onInvalid? + +> `optional` **onInvalid**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalid` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2419 + +*** + +### onInvalidCapture? + +> `optional` **onInvalidCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onInvalidCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2420 + +*** + +### onKeyDown? + +> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2429 + +*** + +### onKeyDownCapture? + +> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2430 + +*** + +### ~~onKeyPress?~~ + +> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUp` or `onKeyDown` instead + +#### Inherited from + +`Omit.onKeyPress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2432 + +*** + +### ~~onKeyPressCapture?~~ + +> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Deprecated + +Use `onKeyUpCapture` or `onKeyDownCapture` instead + +#### Inherited from + +`Omit.onKeyPressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2434 + +*** + +### onKeyUp? + +> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2435 + +*** + +### onKeyUpCapture? + +> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onKeyUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2436 + +*** + +### onLoad? + +> `optional` **onLoad**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoad` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2423 + +*** + +### onLoadCapture? + +> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2424 + +*** + +### onLoadedData? + +> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedData` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2453 + +*** + +### onLoadedDataCapture? + +> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedDataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2454 + +*** + +### onLoadedMetadata? + +> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadata` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2455 + +*** + +### onLoadedMetadataCapture? + +> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadedMetadataCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2456 + +*** + +### onLoadStart? + +> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2457 + +*** + +### onLoadStartCapture? + +> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLoadStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2458 + +*** + +### onLostPointerCapture? + +> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2555 + +*** + +### onLostPointerCaptureCapture? + +> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onLostPointerCaptureCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2556 + +*** + +### onMouseDown? + +> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2511 + +*** + +### onMouseDownCapture? + +> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2512 + +*** + +### onMouseEnter? + +> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2513 + +*** + +### onMouseLeave? + +> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2514 + +*** + +### onMouseMove? + +> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2515 + +*** + +### onMouseMoveCapture? + +> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2516 + +*** + +### onMouseOut? + +> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2517 + +*** + +### onMouseOutCapture? + +> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2518 + +*** + +### onMouseOver? + +> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2519 + +*** + +### onMouseOverCapture? + +> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2520 + +*** + +### onMouseUp? + +> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2521 + +*** + +### onMouseUpCapture? + +> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onMouseUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2522 + +*** + +### onPaste? + +> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPaste` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2391 + +*** + +### onPasteCapture? + +> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPasteCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2392 + +*** + +### onPause? + +> `optional` **onPause**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPause` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2459 + +*** + +### onPauseCapture? + +> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPauseCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2460 + +*** + +### onPlay? + +> `optional` **onPlay**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlay` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2461 + +*** + +### onPlayCapture? + +> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2462 + +*** + +### onPlaying? + +> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlaying` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2463 + +*** + +### onPlayingCapture? + +> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPlayingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2464 + +*** + +### onPointerCancel? + +> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2545 + +*** + +### onPointerCancelCapture? + +> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2546 + +*** + +### onPointerDown? + +> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDown` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2539 + +*** + +### onPointerDownCapture? + +> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerDownCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2540 + +*** + +### onPointerEnter? + +> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerEnter` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2547 + +*** + +### onPointerLeave? + +> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerLeave` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2548 + +*** + +### onPointerMove? + +> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2541 + +*** + +### onPointerMoveCapture? + +> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2542 + +*** + +### onPointerOut? + +> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOut` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2551 + +*** + +### onPointerOutCapture? + +> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOutCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2552 + +*** + +### onPointerOver? + +> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOver` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2549 + +*** + +### onPointerOverCapture? + +> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerOverCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2550 + +*** + +### onPointerUp? + +> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUp` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2543 + +*** + +### onPointerUpCapture? + +> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onPointerUpCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2544 + +*** + +### onProgress? + +> `optional` **onProgress**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgress` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2465 + +*** + +### onProgressCapture? + +> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onProgressCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2466 + +*** + +### onRateChange? + +> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2467 + +*** + +### onRateChangeCapture? + +> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onRateChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2468 + +*** + +### onReset? + +> `optional` **onReset**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onReset` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2415 + +*** + +### onResetCapture? + +> `optional` **onResetCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResetCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2416 + +*** + +### onResize? + +> `optional` **onResize**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResize` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2469 + +*** + +### onResizeCapture? + +> `optional` **onResizeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onResizeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2470 + +*** + +### onScroll? + +> `optional` **onScroll**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScroll` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2559 + +*** + +### onScrollCapture? + +> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onScrollCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2560 + +*** + +### onSeeked? + +> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeked` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2471 + +*** + +### onSeekedCapture? + +> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekedCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2472 + +*** + +### onSeeking? + +> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeeking` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2473 + +*** + +### onSeekingCapture? + +> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSeekingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2474 + +*** + +### onSelect? + +> `optional` **onSelect**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelect` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2525 + +*** + +### onSelectCapture? + +> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSelectCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2526 + +*** + +### onStalled? + +> `optional` **onStalled**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalled` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2475 + +*** + +### onStalledCapture? + +> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onStalledCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2476 + +*** + +### onSubmit? + +> `optional` **onSubmit**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmit` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2417 + +*** + +### onSubmitCapture? + +> `optional` **onSubmitCapture**: `FormEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSubmitCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2418 + +*** + +### onSuspend? + +> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspend` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2477 + +*** + +### onSuspendCapture? + +> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onSuspendCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2478 + +*** + +### onTimeUpdate? + +> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2479 + +*** + +### onTimeUpdateCapture? + +> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTimeUpdateCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2480 + +*** + +### onToggle? + +> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onToggle` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:130 + +*** + +### onTouchCancel? + +> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2529 + +*** + +### onTouchCancelCapture? + +> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchCancelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2530 + +*** + +### onTouchEnd? + +> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2531 + +*** + +### onTouchEndCapture? + +> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2532 + +*** + +### onTouchMove? + +> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMove` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2533 + +*** + +### onTouchMoveCapture? + +> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchMoveCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2534 + +*** + +### onTouchStart? + +> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStart` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2535 + +*** + +### onTouchStartCapture? + +> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTouchStartCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2536 + +*** + +### onTransitionCancel? + +> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancel` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:116 + +*** + +### onTransitionCancelCapture? + +> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionCancelCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:117 + +*** + +### onTransitionEnd? + +> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEnd` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2575 + +*** + +### onTransitionEndCapture? + +> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionEndCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2576 + +*** + +### onTransitionRun? + +> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRun` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:118 + +*** + +### onTransitionRunCapture? + +> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionRunCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:119 + +*** + +### onTransitionStart? + +> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStart` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:120 + +*** + +### onTransitionStartCapture? + +> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onTransitionStartCapture` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:121 + +*** + +### onVolumeChange? + +> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChange` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2481 + +*** + +### onVolumeChangeCapture? + +> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onVolumeChangeCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2482 + +*** + +### onWaiting? + +> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaiting` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2483 + +*** + +### onWaitingCapture? + +> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWaitingCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2484 + +*** + +### onWheel? + +> `optional` **onWheel**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2563 + +*** + +### onWheelCapture? + +> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.onWheelCapture` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2564 + +*** + +### popover? + +> `optional` **popover**: `""` \| `"auto"` \| `"manual"` + +#### Inherited from + +`Omit.popover` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:127 + +*** + +### popoverTarget? + +> `optional` **popoverTarget**: `string` + +#### Inherited from + +`Omit.popoverTarget` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:129 + +*** + +### popoverTargetAction? + +> `optional` **popoverTargetAction**: `"hide"` \| `"show"` \| `"toggle"` + +#### Inherited from + +`Omit.popoverTargetAction` + +#### Defined in + +node\_modules/@types/react/canary.d.ts:128 + +*** + +### prefix? + +> `optional` **prefix**: `string` + +#### Inherited from + +`Omit.prefix` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2924 + +*** + +### property? + +> `optional` **property**: `string` + +#### Inherited from + +`Omit.property` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2925 + +*** + +### radioGroup? + +> `optional` **radioGroup**: `string` + +#### Inherited from + +`Omit.radioGroup` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2914 + +*** + +### readOnly? + +> `optional` **readOnly**: `boolean` + +#### Inherited from + +`Omit.readOnly` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:69 + +*** + +### ref? + +> `optional` **ref**: `null` \| (`instance`) => `void` \| () => `VoidOrUndefinedOnly` \| `RefObject`\<`HTMLButtonElement`\> + +#### Inherited from + +`Omit.ref` + +#### Defined in + +node\_modules/@types/react/index.d.ts:1619 + +*** + +### rel? + +> `optional` **rel**: `string` + +#### Inherited from + +`Omit.rel` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2926 + +*** + +### required? + +> `optional` **required**: `boolean` + +If `true`, the `input` element is required. + +#### Default + +```ts +false +``` + +#### Inherited from + +`Omit.required` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:74 + +*** + +### resource? + +> `optional` **resource**: `string` + +#### Inherited from + +`Omit.resource` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2927 + +*** + +### results? + +> `optional` **results**: `number` + +#### Inherited from + +`Omit.results` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2942 + +*** + +### rev? + +> `optional` **rev**: `string` + +#### Inherited from + +`Omit.rev` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2928 + +*** + +### role? + +> `optional` **role**: `AriaRole` + +#### Inherited from + +`Omit.role` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2917 + +*** + +### security? + +> `optional` **security**: `string` + +#### Inherited from + +`Omit.security` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2943 + +*** + +### size? + +> `optional` **size**: `"medium"` \| `"small"` + +The size of the component. +`small` is equivalent to the dense switch styling. + +#### Default + +```ts +'medium' +``` + +#### Overrides + +`Omit.size` + +#### Defined in + +[src/types/Switch.types.d.ts:18](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L18) + +*** + +### slot? + +> `optional` **slot**: `string` + +#### Inherited from + +`Omit.slot` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2906 + +*** + +### spellCheck? + +> `optional` **spellCheck**: `Booleanish` + +#### Inherited from + +`Omit.spellCheck` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2907 + +*** + +### style? + +> `optional` **style**: `CSSProperties` + +#### Inherited from + +`Omit.style` + +#### Defined in + +node\_modules/@mui/material/OverridableComponent.d.ts:61 + +*** + +### suppressContentEditableWarning? + +> `optional` **suppressContentEditableWarning**: `boolean` + +#### Inherited from + +`Omit.suppressContentEditableWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2891 + +*** + +### suppressHydrationWarning? + +> `optional` **suppressHydrationWarning**: `boolean` + +#### Inherited from + +`Omit.suppressHydrationWarning` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2892 + +*** + +### sx? + +> `optional` **sx**: `SxProps`\<`Theme`\> + +The system prop that allows defining system overrides as well as additional CSS styles. + +#### Overrides + +`Omit.sx` + +#### Defined in + +[src/types/Switch.types.d.ts:19](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L19) + +*** + +### tabIndex? + +> `optional` **tabIndex**: `number` + +#### Overrides + +`Omit.tabIndex` + +#### Defined in + +[src/types/Switch.types.d.ts:22](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L22) + +*** + +### title? + +> `optional` **title**: `string` + +#### Inherited from + +`Omit.title` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2910 + +*** + +### TouchRippleProps? + +> `optional` **TouchRippleProps**: `Partial`\<`TouchRippleProps`\> + +Props applied to the `TouchRipple` element. + +#### Inherited from + +`Omit.TouchRippleProps` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:81 + +*** + +### touchRippleRef? + +> `optional` **touchRippleRef**: `Ref`\<`TouchRippleActions`\> + +A ref that points to the `TouchRipple` element. + +#### Inherited from + +`Omit.touchRippleRef` + +#### Defined in + +node\_modules/@mui/material/ButtonBase/ButtonBase.d.ts:85 + +*** + +### translate? + +> `optional` **translate**: `"yes"` \| `"no"` + +#### Inherited from + +`Omit.translate` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2911 + +*** + +### type? + +> `optional` **type**: `HTMLInputTypeAttribute` + +#### Inherited from + +`Omit.type` + +#### Defined in + +node\_modules/@mui/material/internal/SwitchBase.d.ts:76 + +*** + +### typeof? + +> `optional` **typeof**: `string` + +#### Inherited from + +`Omit.typeof` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2929 + +*** + +### unselectable? + +> `optional` **unselectable**: `"on"` \| `"off"` + +#### Inherited from + +`Omit.unselectable` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2944 + +*** + +### value? + +> `optional` **value**: `unknown` + +The value of the component. The DOM API casts this to a string. +The browser uses "on" as the default value. + +#### Overrides + +`Omit.value` + +#### Defined in + +[src/types/Switch.types.d.ts:20](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Switch.types.d.ts#L20) + +*** + +### vocab? + +> `optional` **vocab**: `string` + +#### Inherited from + +`Omit.vocab` + +#### Defined in + +node\_modules/@types/react/index.d.ts:2930 diff --git a/docs/types/Text.types/functions/default.md b/docs/types/Text.types/functions/default.md new file mode 100644 index 0000000..0c758df --- /dev/null +++ b/docs/types/Text.types/functions/default.md @@ -0,0 +1,33 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Text.types](../README.md) / default + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +## Parameters + +### props + +[`TextProps`](../interfaces/TextProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +## Defined in + +[src/types/Text.types.d.ts:35](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L35) diff --git a/docs/types/Text.types/interfaces/TextProps.md b/docs/types/Text.types/interfaces/TextProps.md new file mode 100644 index 0000000..8a1a725 --- /dev/null +++ b/docs/types/Text.types/interfaces/TextProps.md @@ -0,0 +1,77 @@ +[**the-cdj-ui**](../../../README.md) + +*** + +[the-cdj-ui](../../../README.md) / [types/Text.types](../README.md) / TextProps + +# Interface: TextProps + +## Properties + +### align? + +> `optional` **align**: `"inherit"` \| `"center"` \| `"right"` \| `"left"` \| `"justify"` + +#### Defined in + +[src/types/Text.types.d.ts:20](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L20) + +*** + +### children + +> **children**: `ReactNode` + +#### Defined in + +[src/types/Text.types.d.ts:31](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L31) + +*** + +### color? + +> `optional` **color**: `"primary"` \| `"secondary"` \| `"inherit"` \| `"initial"` \| `"textPrimary"` \| `"textSecondary"` \| `"error"` + +#### Defined in + +[src/types/Text.types.d.ts:21](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L21) + +*** + +### gutterBottom? + +> `optional` **gutterBottom**: `boolean` + +#### Defined in + +[src/types/Text.types.d.ts:29](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L29) + +*** + +### noWrap? + +> `optional` **noWrap**: `boolean` + +#### Defined in + +[src/types/Text.types.d.ts:30](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L30) + +*** + +### sx? + +> `optional` **sx**: `SxProps` + +#### Defined in + +[src/types/Text.types.d.ts:32](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L32) + +*** + +### variant? + +> `optional` **variant**: `"h1"` \| `"h2"` \| `"h3"` \| `"h4"` \| `"h5"` \| `"h6"` \| `"subtitle1"` \| `"subtitle2"` \| `"body1"` \| `"body2"` \| `"caption"` \| `"button"` \| `"overline"` + +#### Defined in + +[src/types/Text.types.d.ts:6](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/types/Text.types.d.ts#L6) diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js index 417c5e9..210ca16 100644 --- a/docusaurus/docusaurus.config.js +++ b/docusaurus/docusaurus.config.js @@ -14,7 +14,7 @@ const config = { projectName: 'the-cdj-ui', onBrokenLinks: 'warn', - onBrokenMarkdownLinks: 'warn', + onBrokenMarkdownLinks: 'ignore', i18n: { defaultLocale: 'en', diff --git a/scripts/typedoc/generate-docs.sh b/scripts/typedoc/generate-docs.sh index 16bba49..32b8f5b 100755 --- a/scripts/typedoc/generate-docs.sh +++ b/scripts/typedoc/generate-docs.sh @@ -20,6 +20,10 @@ fi echo "Running TypeDoc..." npx typedoc +# Delete all README.md files generated by TypeDoc +echo "Deleting all auto-generated README.md files..." +find $DOCS_DIR -type f -name "README.md" -not -path "$BACKUP_DIR/*" -delete + # Restore the backed-up README.md if [ -f "$BACKUP_DIR/README.md" ]; then echo "Restoring the backed-up README.md..." diff --git a/scripts/typedoc/plugins/custom-output.mjs b/scripts/typedoc/plugins/custom-output.mjs deleted file mode 100644 index 60bf7bc..0000000 --- a/scripts/typedoc/plugins/custom-output.mjs +++ /dev/null @@ -1,19 +0,0 @@ -// @ts-check -import { join } from 'path'; -import { renameSync } from 'fs'; - -/** @param {import('typedoc').Application} app */ -export function load(app) { - app.renderer.on('endRender', () => { - const outputDir = app.options.getValue('out'); - const functionsDir = join(outputDir, 'functions'); - const componentsDir = join(outputDir, 'Components'); - - try { - renameSync(functionsDir, componentsDir); - console.log(`Renamed directory: ${functionsDir} -> ${componentsDir}`); - } catch (error) { - console.error(`Error renaming directory: ${error.message}`); - } - }); -} diff --git a/typedoc.json b/typedoc.json index a9f7f9f..8b6a3f5 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,18 +1,12 @@ { "entryPoints": [ - "src/app/page.tsx" + "src", ], + "entryPointStrategy": "expand", "out": "docs", - "outputs": [ - { - "name": "md", - "path": "Components" - } - ], "plugin": [ "typedoc-plugin-markdown", - "./scripts/typedoc/plugins/custom-output.mjs" ], "excludePrivate": true, - "readme": "none" + "readme": "none", } \ No newline at end of file