@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/FormFieldProps.md

@@ -1,166 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FormFieldProps
-
-# Interface: FormFieldProps\<TFieldValues, TName\>
-
-Props for the FormField component
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TFieldValues` | extends `FieldValues` = `FieldValues` |
-| `TName` | extends `FieldPath`\<`TFieldValues`\> = `FieldPath`\<`TFieldValues`\> |
-
-## Table of contents
-
-### Properties
-
-- [name](FormFieldProps.md#name)
-- [label](FormFieldProps.md#label)
-- [type](FormFieldProps.md#type)
-- [placeholder](FormFieldProps.md#placeholder)
-- [inputProps](FormFieldProps.md#inputprops)
-- [validation](FormFieldProps.md#validation)
-- [render](FormFieldProps.md#render)
-- [data-testid](FormFieldProps.md#data-testid)
-- [className](FormFieldProps.md#classname)
-
-## Properties
-
-### name
-
-• **name**: `TName`
-
-Field name
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:180](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L180)
-
-___
-
-### label
-
-• `Optional` **label**: `string`
-
-Field label
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:185](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L185)
-
-___
-
-### type
-
-• `Optional` **type**: `string`
-
-Field type
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:190](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L190)
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-Placeholder text
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:195](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L195)
-
-___
-
-### inputProps
-
-• `Optional` **inputProps**: `InputHTMLAttributes`\<`HTMLInputElement`\>
-
-Additional props for the input
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:200](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L200)
-
-___
-
-### validation
-
-• `Optional` **validation**: `Object`
-
-Validation rules
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `required?` | `boolean` |
-| `pattern?` | \{ `value`: `RegExp` ; `message`: `string`  } |
-| `pattern.value` | `RegExp` |
-| `pattern.message` | `string` |
-| `minLength?` | \{ `value`: `number` ; `message`: `string`  } |
-| `minLength.value` | `number` |
-| `minLength.message` | `string` |
-| `maxLength?` | \{ `value`: `number` ; `message`: `string`  } |
-| `maxLength.value` | `number` |
-| `maxLength.message` | `string` |
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:205](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L205)
-
-___
-
-### render
-
-• `Optional` **render**: (`props`: \{ `field`: `ControllerRenderProps`\<`TFieldValues`, `TName`\> ; `fieldState`: `ControllerFieldState` ; `formState`: `UseFormStateReturn`\<`TFieldValues`\>  }) => `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-Custom render function
-
-#### Type declaration
-
-▸ (`props`): `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `props` | `Object` |
-| `props.field` | `ControllerRenderProps`\<`TFieldValues`, `TName`\> |
-| `props.fieldState` | `ControllerFieldState` |
-| `props.formState` | `UseFormStateReturn`\<`TFieldValues`\> |
-
-##### Returns
-
-`ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:224](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L224)
-
-___
-
-### data-testid
-
-• `Optional` **data-testid**: `string`
-
-Test ID
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:233](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L233)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Class name
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:238](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L238)

package/docs/api/interfaces/FormProps.md

@@ -1,113 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FormProps
-
-# Interface: FormProps\<TFieldValues\>
-
-Props for the Form component
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TFieldValues` | extends `FieldValues` = `FieldValues` |
-
-## Table of contents
-
-### Properties
-
-- [schema](FormProps.md#schema)
-- [defaultValues](FormProps.md#defaultvalues)
-- [onSubmit](FormProps.md#onsubmit)
-- [onError](FormProps.md#onerror)
-- [mode](FormProps.md#mode)
-- [children](FormProps.md#children)
-- [className](FormProps.md#classname)
-
-## Properties
-
-### schema
-
-• `Optional` **schema**: `ZodType`\<`TFieldValues`, `ZodTypeDef`, `TFieldValues`\>
-
-Form schema for validation
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L88)
-
-___
-
-### defaultValues
-
-• `Optional` **defaultValues**: `DefaultValues`\<`TFieldValues`\>
-
-Default values for the form
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L93)
-
-___
-
-### onSubmit
-
-• **onSubmit**: `SubmitHandler`\<`TFieldValues`\>
-
-Handler called when form is submitted successfully
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L98)
-
-___
-
-### onError
-
-• `Optional` **onError**: `SubmitErrorHandler`\<`TFieldValues`\>
-
-Handler called when form submission has errors
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L103)
-
-___
-
-### mode
-
-• `Optional` **mode**: ``"onBlur"`` \| ``"onChange"`` \| ``"onSubmit"`` \| ``"all"`` \| ``"onTouched"``
-
-Form mode for react-hook-form
-
-**`Default`**
-
-```ts
-"onSubmit"
-```
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L109)
-
-___
-
-### children
-
-• **children**: `ReactNode` \| (`methods`: `UseFormReturn`\<`TFieldValues`\>) => `ReactNode`
-
-Children components or render function
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:114](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L114)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Class name for the form
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L119)

package/docs/api/interfaces/GrantEventAppRoleParams.md

@@ -1,122 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / GrantEventAppRoleParams
-
-# Interface: GrantEventAppRoleParams
-
-## Hierarchy
-
-- [`EventAppRoleData`](EventAppRoleData.md)
-
-  ↳ **`GrantEventAppRoleParams`**
-
-## Table of contents
-
-### Properties
-
-- [user\_id](GrantEventAppRoleParams.md#user_id)
-- [organisation\_id](GrantEventAppRoleParams.md#organisation_id)
-- [event\_id](GrantEventAppRoleParams.md#event_id)
-- [app\_id](GrantEventAppRoleParams.md#app_id)
-- [role](GrantEventAppRoleParams.md#role)
-- [granted\_by](GrantEventAppRoleParams.md#granted_by)
-- [valid\_from](GrantEventAppRoleParams.md#valid_from)
-- [valid\_to](GrantEventAppRoleParams.md#valid_to)
-
-## Properties
-
-### user\_id
-
-• **user\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[user_id](EventAppRoleData.md#user_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L65)
-
-___
-
-### organisation\_id
-
-• **organisation\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[organisation_id](EventAppRoleData.md#organisation_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L66)
-
-___
-
-### event\_id
-
-• **event\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[event_id](EventAppRoleData.md#event_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L67)
-
-___
-
-### app\_id
-
-• **app\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[app_id](EventAppRoleData.md#app_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L68)
-
-___
-
-### role
-
-• **role**: ``"viewer"`` \| ``"participant"`` \| ``"planner"`` \| ``"event_admin"``
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[role](EventAppRoleData.md#role)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L69)
-
-___
-
-### granted\_by
-
-• `Optional` **granted\_by**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L88)
-
-___
-
-### valid\_from
-
-• `Optional` **valid\_from**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L89)
-
-___
-
-### valid\_to
-
-• `Optional` **valid\_to**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L90)

package/docs/api/interfaces/InactivityWarningModalProps.md

@@ -1,115 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / InactivityWarningModalProps
-
-# Interface: InactivityWarningModalProps
-
-## Table of contents
-
-### Properties
-
-- [isOpen](InactivityWarningModalProps.md#isopen)
-- [timeRemaining](InactivityWarningModalProps.md#timeremaining)
-- [onStaySignedIn](InactivityWarningModalProps.md#onstaysignedin)
-- [onSignOutNow](InactivityWarningModalProps.md#onsignoutnow)
-- [title](InactivityWarningModalProps.md#title)
-- [description](InactivityWarningModalProps.md#description)
-- [className](InactivityWarningModalProps.md#classname)
-
-## Properties
-
-### isOpen
-
-• **isOpen**: `boolean`
-
-Whether the modal is open
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:57](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L57)
-
-___
-
-### timeRemaining
-
-• **timeRemaining**: `number`
-
-Time remaining in seconds before auto-logout
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L59)
-
-___
-
-### onStaySignedIn
-
-• **onStaySignedIn**: () => `void`
-
-Callback when user chooses to stay signed in
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:61](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L61)
-
-___
-
-### onSignOutNow
-
-• **onSignOutNow**: () => `void`
-
-Callback when user chooses to sign out immediately
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L63)
-
-___
-
-### title
-
-• `Optional` **title**: `string`
-
-Optional custom title
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L65)
-
-___
-
-### description
-
-• `Optional` **description**: `string`
-
-Optional custom description
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L67)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Optional custom className
-
-#### Defined in
-
-[packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/InactivityWarningModal/InactivityWarningModal.tsx#L69)

package/docs/api/interfaces/InputProps.md

@@ -1,56 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / InputProps
-
-# Interface: InputProps
-
-Props for the Input component.
-Extends standard input HTML attributes.
-
-## Hierarchy
-
-- `Omit`\<`React.InputHTMLAttributes`\<`HTMLInputElement`\>, ``"size"``\>
-
-  ↳ **`InputProps`**
-
-## Table of contents
-
-### Properties
-
-- [variant](InputProps.md#variant)
-- [size](InputProps.md#size)
-- [error](InputProps.md#error)
-
-## Properties
-
-### variant
-
-• `Optional` **variant**: ``"default"`` \| ``"destructive"``
-
-Input variant style
-
-#### Defined in
-
-[packages/core/src/components/Input/Input.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Input/Input.tsx#L67)
-
-___
-
-### size
-
-• `Optional` **size**: ``"sm"`` \| ``"lg"`` \| ``"md"``
-
-Input size
-
-#### Defined in
-
-[packages/core/src/components/Input/Input.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Input/Input.tsx#L72)
-
-___
-
-### error
-
-• `Optional` **error**: `boolean`
-
-Error state for styling
-
-#### Defined in
-
-[packages/core/src/components/Input/Input.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Input/Input.tsx#L77)

package/docs/api/interfaces/LabelProps.md

@@ -1,107 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / LabelProps
-
-# Interface: LabelProps
-
-Props for the Label component
-
-## Hierarchy
-
-- `ComponentPropsWithoutRef`\<typeof `LabelPrimitive.Root`\>
-
-  ↳ **`LabelProps`**
-
-## Table of contents
-
-### Properties
-
-- [required](LabelProps.md#required)
-- [requiredIndicator](LabelProps.md#requiredindicator)
-- [hideRequiredIndicator](LabelProps.md#hiderequiredindicator)
-- [helperText](LabelProps.md#helpertext)
-- [helperTextClassName](LabelProps.md#helpertextclassname)
-- [error](LabelProps.md#error)
-- [errorClassName](LabelProps.md#errorclassname)
-
-## Properties
-
-### required
-
-• `Optional` **required**: `boolean`
-
-Whether the field is required
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L89)
-
-___
-
-### requiredIndicator
-
-• `Optional` **requiredIndicator**: `ReactNode`
-
-Custom required indicator (default: '*')
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L91)
-
-___
-
-### hideRequiredIndicator
-
-• `Optional` **hideRequiredIndicator**: `boolean`
-
-Whether to hide the required indicator visually
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L93)
-
-___
-
-### helperText
-
-• `Optional` **helperText**: `string`
-
-Helper text to display below the label
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L95)
-
-___
-
-### helperTextClassName
-
-• `Optional` **helperTextClassName**: `string`
-
-CSS classes for helper text styling
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L97)
-
-___
-
-### error
-
-• `Optional` **error**: `string`
-
-Error message to display
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:99](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L99)
-
-___
-
-### errorClassName
-
-• `Optional` **errorClassName**: `string`
-
-CSS classes for error message styling
-
-#### Defined in
-
-[packages/core/src/components/Label/Label.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L101)