From 034799bef8f4d406df5a609cc031d6a11191863f Mon Sep 17 00:00:00 2001 From: Pagebakers Date: Fri, 12 Jan 2024 14:03:47 +0000 Subject: [PATCH] chore: check in props docs --- .gitignore | 3 + .../props-docs/dist/components/AppShell.json | 30 + .../dist/components/ArrayField.json | 1 + .../dist/components/ArrayFieldContainer.json | 1 + .../dist/components/ArrayFieldRow.json | 1 + .../components/ArrayFieldRowContainer.json | 1 + .../dist/components/ArrayFieldRowFields.json | 1 + tooling/props-docs/dist/components/Auth.json | 868 +++++ .../dist/components/AuthFormDivider.json | 1 + .../dist/components/AuthFormSuccess.json | 1 + .../dist/components/AuthProvider.json | 1 + .../dist/components/AutoFields.json | 1 + .../props-docs/dist/components/Banner.json | 1083 ++++++ .../dist/components/BannerActions.json | 1 + .../dist/components/BannerCloseButton.json | 1 + .../dist/components/BannerContent.json | 1 + .../dist/components/BannerDescription.json | 1 + .../dist/components/BannerIcon.json | 1 + .../dist/components/BannerTitle.json | 1 + .../dist/components/BaseDrawer.json | 1 + .../props-docs/dist/components/BaseField.json | 1 + .../props-docs/dist/components/BaseModal.json | 1 + .../dist/components/BulkActions.json | 1070 ++++++ .../dist/components/CalendarIcon.json | 1 + .../props-docs/dist/components/Charts.json | 540 +++ .../props-docs/dist/components/CheckIcon.json | 1 + .../dist/components/CheckboxField.json | 1 + .../dist/components/ChevronDownIcon.json | 1 + .../dist/components/ChevronLeftIcon.json | 1 + .../dist/components/ChevronRightIcon.json | 1 + .../dist/components/ChevronUpIcon.json | 1 + .../dist/components/ClerkAuthProvider.json | 1 + .../props-docs/dist/components/CloseIcon.json | 1 + .../props-docs/dist/components/Collapse.json | 1 + .../dist/components/CommandBar.json | 164 + .../dist/components/ConfirmDialog.json | 1 + .../dist/components/ContextMenuItem.json | 1 + .../props-docs/dist/components/DataGrid.json | 513 +++ .../props-docs/dist/components/DataTable.json | 423 +++ .../dist/components/DataTableHeader.json | 1 + .../dist/components/DataTableSort.json | 1 + .../dist/components/DatePicker.json | 3263 +++++++++++++++++ .../dist/components/DatePickerContainer.json | 1 + .../dist/components/DatePickerDialog.json | 1 + .../components/DatePickerEndTimeField.json | 1 + .../dist/components/DatePickerModal.json | 1 + .../components/DatePickerStartTimeField.json | 1 + .../dist/components/DatePickerStatic.json | 1 + .../dist/components/DatePickerTimeField.json | 1 + .../dist/components/DateRangePicker.json | 1 + .../components/DateRangePickerContainer.json | 1 + .../components/DateRangePickerTimeField.json | 1 + .../dist/components/DisplayField.json | 1 + .../props-docs/dist/components/DisplayIf.json | 1 + .../props-docs/dist/components/Divider.json | 1 + .../props-docs/dist/components/Drawer.json | 1 + .../dist/components/EmptyState.json | 45 + .../dist/components/EmptyStateBody.json | 1 + .../dist/components/EmptyStateContainer.json | 1 + .../dist/components/ErrorBoundary.json | 16 + .../dist/components/FeatureFlags.json | 46 + tooling/props-docs/dist/components/Field.json | 1 + .../dist/components/FieldsProvider.json | 1 + .../dist/components/FileUpload.json | 215 ++ .../dist/components/FilterIcon.json | 1 + .../props-docs/dist/components/Filters.json | 1141 ++++++ .../dist/components/ForgotPasswordForm.json | 1 + .../dist/components/ForgotPasswordView.json | 1 + tooling/props-docs/dist/components/Form.json | 1 + .../dist/components/FormDialog.json | 1 + .../dist/components/FormProvider.json | 1 + .../props-docs/dist/components/FormStep.json | 1 + .../dist/components/FormStepper.json | 1 + .../props-docs/dist/components/FormValue.json | 1 + tooling/props-docs/dist/components/Forms.json | 3093 ++++++++++++++++ .../dist/components/HamburgerIcon.json | 1 + tooling/props-docs/dist/components/Hooks.json | 9 + .../props-docs/dist/components/Hotkeys.json | 69 + .../dist/components/HotkeysGroup.json | 1 + .../dist/components/HotkeysItem.json | 1 + .../dist/components/HotkeysList.json | 1 + .../dist/components/HotkeysListItems.json | 1 + .../dist/components/HotkeysProvider.json | 1 + .../dist/components/HotkeysSearch.json | 1 + .../props-docs/dist/components/IconBadge.json | 21 + .../dist/components/InputField.json | 1 + .../dist/components/InputRightButton.json | 1 + .../props-docs/dist/components/Kanban.json | 207 ++ .../props-docs/dist/components/LineChart.json | 1 + tooling/props-docs/dist/components/Link.json | 9 + .../dist/components/LoadingOverlay.json | 54 + .../dist/components/LoginButton.json | 1 + .../props-docs/dist/components/LoginView.json | 1 + .../dist/components/MagicLinkForm.json | 1 + tooling/props-docs/dist/components/Menu.json | 182 + .../dist/components/MenuDialog.json | 1 + .../dist/components/MenuDialogList.json | 1 + .../props-docs/dist/components/MenuItem.json | 1 + .../props-docs/dist/components/MinusIcon.json | 1 + tooling/props-docs/dist/components/Modal.json | 1 + .../props-docs/dist/components/Modals.json | 2124 +++++++++++ .../dist/components/ModalsProvider.json | 1 + .../props-docs/dist/components/NProgress.json | 9 + .../dist/components/NativeSelect.json | 1 + .../dist/components/NativeSelectField.json | 1 + tooling/props-docs/dist/components/Nav.json | 1 + .../props-docs/dist/components/NavGroup.json | 1 + .../dist/components/NavGroupTitle.json | 1 + .../props-docs/dist/components/NavItem.json | 1 + .../dist/components/NavItemLabel.json | 1 + .../props-docs/dist/components/Navbar.json | 97 + .../dist/components/NextButton.json | 1 + .../dist/components/NumberInput.json | 1 + .../dist/components/NumberInputField.json | 1 + .../dist/components/ObjectField.json | 1 + .../dist/components/Onboarding.json | 1005 +++++ .../props-docs/dist/components/OtpForm.json | 1 + .../props-docs/dist/components/OtpView.json | 1 + .../dist/components/OverflowMenu.json | 1 + tooling/props-docs/dist/components/Page.json | 2313 ++++++++++++ .../dist/components/PasswordForm.json | 1 + .../dist/components/PasswordInput.json | 1 + .../dist/components/PasswordInputField.json | 1 + .../props-docs/dist/components/Persona.json | 108 + .../dist/components/PersonaAvatar.json | 1 + .../dist/components/PersonaContainer.json | 1 + .../dist/components/PersonaDetails.json | 1 + .../dist/components/PersonaLabel.json | 1 + .../components/PersonaSecondaryLabel.json | 1 + .../dist/components/PersonaTertiaryLabel.json | 1 + .../props-docs/dist/components/PinField.json | 1 + .../props-docs/dist/components/PinInput.json | 1 + .../props-docs/dist/components/PlusIcon.json | 1 + .../props-docs/dist/components/Property.json | 39 + .../dist/components/PropertyLabel.json | 1 + .../dist/components/PropertyValue.json | 1 + .../props-docs/dist/components/Provider.json | 69 + .../props-docs/dist/components/Providers.json | 1 + .../dist/components/RadioField.json | 1 + .../dist/components/RadioInput.json | 1 + .../props-docs/dist/components/Resize.json | 126 + .../dist/components/SaasProvider.json | 1 + .../dist/components/SearchIcon.json | 1 + .../dist/components/SearchInput.json | 69 + .../props-docs/dist/components/Select.json | 1 + .../dist/components/SelectButton.json | 1 + .../dist/components/SelectField.json | 1 + .../dist/components/SelectOption.json | 1 + .../props-docs/dist/components/Sidebar.json | 190 + .../dist/components/SidebarSection.json | 1 + .../dist/components/SidebarToggleButton.json | 1 + .../dist/components/SignupView.json | 1 + .../props-docs/dist/components/Snackbar.json | 87 + .../dist/components/Sparklines.json | 1 + tooling/props-docs/dist/components/Src.json | 9 + .../props-docs/dist/components/StepForm.json | 1 + .../props-docs/dist/components/Stepper.json | 88 + .../dist/components/StepperContainer.json | 1 + .../dist/components/StepperContent.json | 1 + .../dist/components/StepperIcon.json | 1 + .../dist/components/StepperSeparator.json | 1 + .../dist/components/StepperStep.json | 1 + .../dist/components/StepperSteps.json | 1 + .../dist/components/StructuredList.json | 49 + .../dist/components/StructuredListHeader.json | 1 + .../dist/components/StructuredListIcon.json | 1 + .../dist/components/SubmitButton.json | 1 + .../dist/components/SwitchField.json | 1 + .../dist/components/TextareaField.json | 1 + .../props-docs/dist/components/Timeline.json | 9 + .../dist/components/TimelineItem.json | 1 + .../props-docs/dist/components/Toggle.json | 118 + .../props-docs/dist/components/Toolbar.json | 153 + .../dist/components/UpdatePasswordForm.json | 1 + .../dist/components/UpdatePasswordView.json | 1 + tooling/props-docs/dist/components/Utils.json | 24 + .../props-docs/dist/components/ViewIcon.json | 1 + .../dist/components/ViewOffIcon.json | 1 + .../dist/components/WatchField.json | 1 + .../dist/components/Web3Address.json | 7 + .../props-docs/dist/components/createBox.json | 1 + .../dist/components/createForm.json | 1 + .../dist/components/createFormDialog.json | 1 + .../dist/components/createIcon.json | 1 + .../dist/components/createModals.json | 1 + .../dist/components/endOfMonth.json | 1 + .../props-docs/dist/components/endOfYear.json | 1 + .../dist/components/startOfMonth.json | 1 + .../dist/components/startOfYear.json | 1 + .../dist/components/toLocalTimeZone.json | 1 + .../props-docs/dist/components/toTime.json | 1 + .../dist/components/useArrayField.json | 1 + .../dist/components/useArrayFieldRow.json | 1 + .../dist/components/useCollapse.json | 1 + .../dist/components/useCommandBar.json | 1 + .../dist/components/useContextMenu.json | 1 + .../dist/components/useController.json | 1 + .../dist/components/useFieldArray.json | 1 + .../props-docs/dist/components/useForm.json | 1 + .../dist/components/useFormState.json | 1 + .../dist/components/useFormStep.json | 1 + .../props-docs/dist/components/useLogin.json | 1 + .../dist/components/useSnackbar.json | 1 + .../props-docs/dist/components/useStep.json | 1 + .../dist/components/useStepForm.json | 1 + .../dist/components/useStepper.json | 1 + .../dist/components/useStepperNextButton.json | 1 + .../dist/components/useStepperPrevButton.json | 1 + .../props-docs/dist/components/useSteps.json | 1 + .../props-docs/dist/components/useWatch.json | 1 + tooling/props-docs/dist/index.d.ts | 57 + tooling/props-docs/dist/index.js | 140 + tooling/props-docs/dist/index.mjs | 136 + 213 files changed, 20257 insertions(+) create mode 100644 tooling/props-docs/dist/components/AppShell.json create mode 100644 tooling/props-docs/dist/components/ArrayField.json create mode 100644 tooling/props-docs/dist/components/ArrayFieldContainer.json create mode 100644 tooling/props-docs/dist/components/ArrayFieldRow.json create mode 100644 tooling/props-docs/dist/components/ArrayFieldRowContainer.json create mode 100644 tooling/props-docs/dist/components/ArrayFieldRowFields.json create mode 100644 tooling/props-docs/dist/components/Auth.json create mode 100644 tooling/props-docs/dist/components/AuthFormDivider.json create mode 100644 tooling/props-docs/dist/components/AuthFormSuccess.json create mode 100644 tooling/props-docs/dist/components/AuthProvider.json create mode 100644 tooling/props-docs/dist/components/AutoFields.json create mode 100644 tooling/props-docs/dist/components/Banner.json create mode 100644 tooling/props-docs/dist/components/BannerActions.json create mode 100644 tooling/props-docs/dist/components/BannerCloseButton.json create mode 100644 tooling/props-docs/dist/components/BannerContent.json create mode 100644 tooling/props-docs/dist/components/BannerDescription.json create mode 100644 tooling/props-docs/dist/components/BannerIcon.json create mode 100644 tooling/props-docs/dist/components/BannerTitle.json create mode 100644 tooling/props-docs/dist/components/BaseDrawer.json create mode 100644 tooling/props-docs/dist/components/BaseField.json create mode 100644 tooling/props-docs/dist/components/BaseModal.json create mode 100644 tooling/props-docs/dist/components/BulkActions.json create mode 100644 tooling/props-docs/dist/components/CalendarIcon.json create mode 100644 tooling/props-docs/dist/components/Charts.json create mode 100644 tooling/props-docs/dist/components/CheckIcon.json create mode 100644 tooling/props-docs/dist/components/CheckboxField.json create mode 100644 tooling/props-docs/dist/components/ChevronDownIcon.json create mode 100644 tooling/props-docs/dist/components/ChevronLeftIcon.json create mode 100644 tooling/props-docs/dist/components/ChevronRightIcon.json create mode 100644 tooling/props-docs/dist/components/ChevronUpIcon.json create mode 100644 tooling/props-docs/dist/components/ClerkAuthProvider.json create mode 100644 tooling/props-docs/dist/components/CloseIcon.json create mode 100644 tooling/props-docs/dist/components/Collapse.json create mode 100644 tooling/props-docs/dist/components/CommandBar.json create mode 100644 tooling/props-docs/dist/components/ConfirmDialog.json create mode 100644 tooling/props-docs/dist/components/ContextMenuItem.json create mode 100644 tooling/props-docs/dist/components/DataGrid.json create mode 100644 tooling/props-docs/dist/components/DataTable.json create mode 100644 tooling/props-docs/dist/components/DataTableHeader.json create mode 100644 tooling/props-docs/dist/components/DataTableSort.json create mode 100644 tooling/props-docs/dist/components/DatePicker.json create mode 100644 tooling/props-docs/dist/components/DatePickerContainer.json create mode 100644 tooling/props-docs/dist/components/DatePickerDialog.json create mode 100644 tooling/props-docs/dist/components/DatePickerEndTimeField.json create mode 100644 tooling/props-docs/dist/components/DatePickerModal.json create mode 100644 tooling/props-docs/dist/components/DatePickerStartTimeField.json create mode 100644 tooling/props-docs/dist/components/DatePickerStatic.json create mode 100644 tooling/props-docs/dist/components/DatePickerTimeField.json create mode 100644 tooling/props-docs/dist/components/DateRangePicker.json create mode 100644 tooling/props-docs/dist/components/DateRangePickerContainer.json create mode 100644 tooling/props-docs/dist/components/DateRangePickerTimeField.json create mode 100644 tooling/props-docs/dist/components/DisplayField.json create mode 100644 tooling/props-docs/dist/components/DisplayIf.json create mode 100644 tooling/props-docs/dist/components/Divider.json create mode 100644 tooling/props-docs/dist/components/Drawer.json create mode 100644 tooling/props-docs/dist/components/EmptyState.json create mode 100644 tooling/props-docs/dist/components/EmptyStateBody.json create mode 100644 tooling/props-docs/dist/components/EmptyStateContainer.json create mode 100644 tooling/props-docs/dist/components/ErrorBoundary.json create mode 100644 tooling/props-docs/dist/components/FeatureFlags.json create mode 100644 tooling/props-docs/dist/components/Field.json create mode 100644 tooling/props-docs/dist/components/FieldsProvider.json create mode 100644 tooling/props-docs/dist/components/FileUpload.json create mode 100644 tooling/props-docs/dist/components/FilterIcon.json create mode 100644 tooling/props-docs/dist/components/Filters.json create mode 100644 tooling/props-docs/dist/components/ForgotPasswordForm.json create mode 100644 tooling/props-docs/dist/components/ForgotPasswordView.json create mode 100644 tooling/props-docs/dist/components/Form.json create mode 100644 tooling/props-docs/dist/components/FormDialog.json create mode 100644 tooling/props-docs/dist/components/FormProvider.json create mode 100644 tooling/props-docs/dist/components/FormStep.json create mode 100644 tooling/props-docs/dist/components/FormStepper.json create mode 100644 tooling/props-docs/dist/components/FormValue.json create mode 100644 tooling/props-docs/dist/components/Forms.json create mode 100644 tooling/props-docs/dist/components/HamburgerIcon.json create mode 100644 tooling/props-docs/dist/components/Hooks.json create mode 100644 tooling/props-docs/dist/components/Hotkeys.json create mode 100644 tooling/props-docs/dist/components/HotkeysGroup.json create mode 100644 tooling/props-docs/dist/components/HotkeysItem.json create mode 100644 tooling/props-docs/dist/components/HotkeysList.json create mode 100644 tooling/props-docs/dist/components/HotkeysListItems.json create mode 100644 tooling/props-docs/dist/components/HotkeysProvider.json create mode 100644 tooling/props-docs/dist/components/HotkeysSearch.json create mode 100644 tooling/props-docs/dist/components/IconBadge.json create mode 100644 tooling/props-docs/dist/components/InputField.json create mode 100644 tooling/props-docs/dist/components/InputRightButton.json create mode 100644 tooling/props-docs/dist/components/Kanban.json create mode 100644 tooling/props-docs/dist/components/LineChart.json create mode 100644 tooling/props-docs/dist/components/Link.json create mode 100644 tooling/props-docs/dist/components/LoadingOverlay.json create mode 100644 tooling/props-docs/dist/components/LoginButton.json create mode 100644 tooling/props-docs/dist/components/LoginView.json create mode 100644 tooling/props-docs/dist/components/MagicLinkForm.json create mode 100644 tooling/props-docs/dist/components/Menu.json create mode 100644 tooling/props-docs/dist/components/MenuDialog.json create mode 100644 tooling/props-docs/dist/components/MenuDialogList.json create mode 100644 tooling/props-docs/dist/components/MenuItem.json create mode 100644 tooling/props-docs/dist/components/MinusIcon.json create mode 100644 tooling/props-docs/dist/components/Modal.json create mode 100644 tooling/props-docs/dist/components/Modals.json create mode 100644 tooling/props-docs/dist/components/ModalsProvider.json create mode 100644 tooling/props-docs/dist/components/NProgress.json create mode 100644 tooling/props-docs/dist/components/NativeSelect.json create mode 100644 tooling/props-docs/dist/components/NativeSelectField.json create mode 100644 tooling/props-docs/dist/components/Nav.json create mode 100644 tooling/props-docs/dist/components/NavGroup.json create mode 100644 tooling/props-docs/dist/components/NavGroupTitle.json create mode 100644 tooling/props-docs/dist/components/NavItem.json create mode 100644 tooling/props-docs/dist/components/NavItemLabel.json create mode 100644 tooling/props-docs/dist/components/Navbar.json create mode 100644 tooling/props-docs/dist/components/NextButton.json create mode 100644 tooling/props-docs/dist/components/NumberInput.json create mode 100644 tooling/props-docs/dist/components/NumberInputField.json create mode 100644 tooling/props-docs/dist/components/ObjectField.json create mode 100644 tooling/props-docs/dist/components/Onboarding.json create mode 100644 tooling/props-docs/dist/components/OtpForm.json create mode 100644 tooling/props-docs/dist/components/OtpView.json create mode 100644 tooling/props-docs/dist/components/OverflowMenu.json create mode 100644 tooling/props-docs/dist/components/Page.json create mode 100644 tooling/props-docs/dist/components/PasswordForm.json create mode 100644 tooling/props-docs/dist/components/PasswordInput.json create mode 100644 tooling/props-docs/dist/components/PasswordInputField.json create mode 100644 tooling/props-docs/dist/components/Persona.json create mode 100644 tooling/props-docs/dist/components/PersonaAvatar.json create mode 100644 tooling/props-docs/dist/components/PersonaContainer.json create mode 100644 tooling/props-docs/dist/components/PersonaDetails.json create mode 100644 tooling/props-docs/dist/components/PersonaLabel.json create mode 100644 tooling/props-docs/dist/components/PersonaSecondaryLabel.json create mode 100644 tooling/props-docs/dist/components/PersonaTertiaryLabel.json create mode 100644 tooling/props-docs/dist/components/PinField.json create mode 100644 tooling/props-docs/dist/components/PinInput.json create mode 100644 tooling/props-docs/dist/components/PlusIcon.json create mode 100644 tooling/props-docs/dist/components/Property.json create mode 100644 tooling/props-docs/dist/components/PropertyLabel.json create mode 100644 tooling/props-docs/dist/components/PropertyValue.json create mode 100644 tooling/props-docs/dist/components/Provider.json create mode 100644 tooling/props-docs/dist/components/Providers.json create mode 100644 tooling/props-docs/dist/components/RadioField.json create mode 100644 tooling/props-docs/dist/components/RadioInput.json create mode 100644 tooling/props-docs/dist/components/Resize.json create mode 100644 tooling/props-docs/dist/components/SaasProvider.json create mode 100644 tooling/props-docs/dist/components/SearchIcon.json create mode 100644 tooling/props-docs/dist/components/SearchInput.json create mode 100644 tooling/props-docs/dist/components/Select.json create mode 100644 tooling/props-docs/dist/components/SelectButton.json create mode 100644 tooling/props-docs/dist/components/SelectField.json create mode 100644 tooling/props-docs/dist/components/SelectOption.json create mode 100644 tooling/props-docs/dist/components/Sidebar.json create mode 100644 tooling/props-docs/dist/components/SidebarSection.json create mode 100644 tooling/props-docs/dist/components/SidebarToggleButton.json create mode 100644 tooling/props-docs/dist/components/SignupView.json create mode 100644 tooling/props-docs/dist/components/Snackbar.json create mode 100644 tooling/props-docs/dist/components/Sparklines.json create mode 100644 tooling/props-docs/dist/components/Src.json create mode 100644 tooling/props-docs/dist/components/StepForm.json create mode 100644 tooling/props-docs/dist/components/Stepper.json create mode 100644 tooling/props-docs/dist/components/StepperContainer.json create mode 100644 tooling/props-docs/dist/components/StepperContent.json create mode 100644 tooling/props-docs/dist/components/StepperIcon.json create mode 100644 tooling/props-docs/dist/components/StepperSeparator.json create mode 100644 tooling/props-docs/dist/components/StepperStep.json create mode 100644 tooling/props-docs/dist/components/StepperSteps.json create mode 100644 tooling/props-docs/dist/components/StructuredList.json create mode 100644 tooling/props-docs/dist/components/StructuredListHeader.json create mode 100644 tooling/props-docs/dist/components/StructuredListIcon.json create mode 100644 tooling/props-docs/dist/components/SubmitButton.json create mode 100644 tooling/props-docs/dist/components/SwitchField.json create mode 100644 tooling/props-docs/dist/components/TextareaField.json create mode 100644 tooling/props-docs/dist/components/Timeline.json create mode 100644 tooling/props-docs/dist/components/TimelineItem.json create mode 100644 tooling/props-docs/dist/components/Toggle.json create mode 100644 tooling/props-docs/dist/components/Toolbar.json create mode 100644 tooling/props-docs/dist/components/UpdatePasswordForm.json create mode 100644 tooling/props-docs/dist/components/UpdatePasswordView.json create mode 100644 tooling/props-docs/dist/components/Utils.json create mode 100644 tooling/props-docs/dist/components/ViewIcon.json create mode 100644 tooling/props-docs/dist/components/ViewOffIcon.json create mode 100644 tooling/props-docs/dist/components/WatchField.json create mode 100644 tooling/props-docs/dist/components/Web3Address.json create mode 100644 tooling/props-docs/dist/components/createBox.json create mode 100644 tooling/props-docs/dist/components/createForm.json create mode 100644 tooling/props-docs/dist/components/createFormDialog.json create mode 100644 tooling/props-docs/dist/components/createIcon.json create mode 100644 tooling/props-docs/dist/components/createModals.json create mode 100644 tooling/props-docs/dist/components/endOfMonth.json create mode 100644 tooling/props-docs/dist/components/endOfYear.json create mode 100644 tooling/props-docs/dist/components/startOfMonth.json create mode 100644 tooling/props-docs/dist/components/startOfYear.json create mode 100644 tooling/props-docs/dist/components/toLocalTimeZone.json create mode 100644 tooling/props-docs/dist/components/toTime.json create mode 100644 tooling/props-docs/dist/components/useArrayField.json create mode 100644 tooling/props-docs/dist/components/useArrayFieldRow.json create mode 100644 tooling/props-docs/dist/components/useCollapse.json create mode 100644 tooling/props-docs/dist/components/useCommandBar.json create mode 100644 tooling/props-docs/dist/components/useContextMenu.json create mode 100644 tooling/props-docs/dist/components/useController.json create mode 100644 tooling/props-docs/dist/components/useFieldArray.json create mode 100644 tooling/props-docs/dist/components/useForm.json create mode 100644 tooling/props-docs/dist/components/useFormState.json create mode 100644 tooling/props-docs/dist/components/useFormStep.json create mode 100644 tooling/props-docs/dist/components/useLogin.json create mode 100644 tooling/props-docs/dist/components/useSnackbar.json create mode 100644 tooling/props-docs/dist/components/useStep.json create mode 100644 tooling/props-docs/dist/components/useStepForm.json create mode 100644 tooling/props-docs/dist/components/useStepper.json create mode 100644 tooling/props-docs/dist/components/useStepperNextButton.json create mode 100644 tooling/props-docs/dist/components/useStepperPrevButton.json create mode 100644 tooling/props-docs/dist/components/useSteps.json create mode 100644 tooling/props-docs/dist/components/useWatch.json create mode 100644 tooling/props-docs/dist/index.d.ts create mode 100644 tooling/props-docs/dist/index.js create mode 100644 tooling/props-docs/dist/index.mjs diff --git a/.gitignore b/.gitignore index d0bc75407..5e9f23ff9 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,9 @@ __snapshots__ **/dist **/build/** +# we include these files so they don't have to be re-build when deploying to Vercel +!tooling/props-docs/dist + # misc .DS_Store *.pem diff --git a/tooling/props-docs/dist/components/AppShell.json b/tooling/props-docs/dist/components/AppShell.json new file mode 100644 index 000000000..17d9002c9 --- /dev/null +++ b/tooling/props-docs/dist/components/AppShell.json @@ -0,0 +1,30 @@ +{ + "AppShell": { + "aside": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Secondary sidebar, positioned on the right" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The main content" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The footer" + }, + "mainRef": { "type": "RefObject", "required": false }, + "navbar": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The top header navigation" + }, + "sidebar": { + "type": "ReactElement>", + "required": false, + "description": "Main sidebar, positioned on the left" + } + } +} diff --git a/tooling/props-docs/dist/components/ArrayField.json b/tooling/props-docs/dist/components/ArrayField.json new file mode 100644 index 000000000..918f54470 --- /dev/null +++ b/tooling/props-docs/dist/components/ArrayField.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The wrapper component that composes the default ArrayField functionality.","displayName":"ArrayField","methods":[],"props":{"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":true,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"Default value for new values in the array","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"Record"}},"keyName":{"defaultValue":{"value":"\"id\""},"description":"Default key name for rows, change this if your data uses a different 'id' field","name":"keyName","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"string"}},"min":{"defaultValue":null,"description":"","name":"min","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"max":{"defaultValue":null,"description":"","name":"max","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ArrayFieldContainer.json b/tooling/props-docs/dist/components/ArrayFieldContainer.json new file mode 100644 index 000000000..0ea04af5b --- /dev/null +++ b/tooling/props-docs/dist/components/ArrayFieldContainer.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The container component provides context and state management.","displayName":"ArrayFieldContainer","methods":[],"props":{"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"Default value for new values in the array","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"Record"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"min":{"defaultValue":null,"description":"","name":"min","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"max":{"defaultValue":null,"description":"","name":"max","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":true,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"keyName":{"defaultValue":{"value":"\"id\""},"description":"Default key name for rows, change this if your data uses a different 'id' field","name":"keyName","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ArrayFieldRow.json b/tooling/props-docs/dist/components/ArrayFieldRow.json new file mode 100644 index 000000000..a4b164b07 --- /dev/null +++ b/tooling/props-docs/dist/components/ArrayFieldRow.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Render prop component, to get access to the internal fields state. Must be a child of ArrayFieldContainer.","displayName":"ArrayFieldRow","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"index":{"defaultValue":null,"description":"The array index","name":"index","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"number"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ArrayFieldRowContainer.json b/tooling/props-docs/dist/components/ArrayFieldRowContainer.json new file mode 100644 index 000000000..25bf060f1 --- /dev/null +++ b/tooling/props-docs/dist/components/ArrayFieldRowContainer.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The row container component providers row context.","displayName":"ArrayFieldRowContainer","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"index":{"defaultValue":null,"description":"The array index","name":"index","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"number"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ArrayFieldRowFields.json b/tooling/props-docs/dist/components/ArrayFieldRowFields.json new file mode 100644 index 000000000..5575c1aad --- /dev/null +++ b/tooling/props-docs/dist/components/ArrayFieldRowFields.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Add the name prefix to the fields and acts as a horizontal form layout by default.","displayName":"ArrayFieldRowFields","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":true,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Auth.json b/tooling/props-docs/dist/components/Auth.json new file mode 100644 index 000000000..a9311c014 --- /dev/null +++ b/tooling/props-docs/dist/components/Auth.json @@ -0,0 +1,868 @@ +{ + "AuthOptions": { + "redirectTo": { + "type": "string", + "required": false, + "description": "The url to redirect to after social or magic link login." + } + }, + "ExtraAuthOptions": {}, + "UseLogin": { "action": { "type": "AuthActionEnum", "required": false } }, + "AuthProvider": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "onAuthStateChange": { + "type": "(\n callback: AuthStateChangeCallback\n) => UnsubscribeHandler", + "required": false, + "description": "Should trigger whenever the authentication state changes" + }, + "onGetToken": { + "type": "() => Promise", + "required": false, + "description": "Return the session token" + }, + "onLoadUser": { + "type": "() => Promise", + "required": false, + "description": "Loads user data after authentication" + }, + "onLogin": { + "type": "(\n params: AuthParams,\n options?: AuthOptions | undefined\n) => Promise", + "required": false, + "description": "The login method" + }, + "onLogout": { + "type": "(\n options?: AuthOptions | undefined\n) => Promise", + "required": false, + "description": "The logout method" + }, + "onResetPassword": { + "type": "(\n params: Required>,\n options?: AuthOptions | undefined\n) => Promise", + "required": false, + "description": "Request to reset a password." + }, + "onSignup": { + "type": "(\n params: AuthParams,\n options?: AuthOptions | undefined\n) => Promise", + "required": false, + "description": "The signup method" + }, + "onUpdatePassword": { + "type": "(params: Required>, options?: AuthOptions | undefined) => Promise<...>", + "required": false, + "description": "Update the password." + }, + "onVerifyOtp": { + "type": "(\n params: OtpParams,\n options?: AuthOptions | undefined\n) => Promise", + "required": false, + "description": "Verify an one time password (2fa)" + } + }, + "AuthFormContainer": {}, + "AuthFormDivider": { "label": { "type": "string", "required": false } }, + "AuthFormOptions": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The child component" + }, + "dividerLabel": { + "type": "string", + "defaultValue": "or continue with", + "required": false, + "description": "Label for the divider between oath and the form" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render custom elements under the submit button" + }, + "oauthRedirectUrl": { + "type": "string", + "required": false, + "description": "The redirect URL after successful OAuth login" + }, + "providerLabel": { + "type": "string", + "defaultValue": "Continue with", + "required": false, + "description": "Label for the provider buttons" + }, + "providers": { + "type": "AvailableProviders", + "required": false, + "description": "List of OAuth providers" + }, + "redirectUrl": { + "type": "string", + "required": false, + "description": "The redirecet URL after succesful magic link or password login" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form title" + }, + "type": { + "type": "AuthTypeEnum", + "required": false, + "description": "The authentication type, `magiclink` or `password`" + } + }, + "AuthFormSuccess": { + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "Auth": { + "backLink": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "Back to log in", + "required": false, + "description": "Back to log in link" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The child component" + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "delayError": { "type": "number", "required": false }, + "dividerLabel": { + "type": "string", + "defaultValue": "or continue with", + "required": false, + "description": "Label for the divider between oath and the form" + }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render custom elements under the submit button" + }, + "forgotLink": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "Forgot password?", + "required": false, + "description": "The forgot password link" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "haveAccount": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "Already have an account?", + "required": false, + "description": "Text shown before the loginLink" + }, + "loginLink": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "Log in", + "required": false, + "description": "Customize the login link under the sign up form." + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "noAccount": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "No account?", + "required": false, + "description": "Text shown before the signupLink" + }, + "oauthRedirectUrl": { + "type": "string", + "required": false, + "description": "The redirect URL after successful OAuth login" + }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "(view: ViewType, error: Error) => void", + "required": false, + "description": "Called when a login or signup request fails." + }, + "progressive": { "type": "boolean", "required": false }, + "providerLabel": { + "type": "string", + "defaultValue": "Continue with", + "required": false, + "description": "Label for the provider buttons" + }, + "providers": { + "type": "AvailableProviders", + "required": false, + "description": "The OAuth providers that are supported." + }, + "redirectUrl": { + "type": "string", + "required": false, + "description": "The redirecet URL after succesful magic link or password login" + }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "signupLink": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "defaultValue": "Sign up", + "required": false, + "description": "Customize the signup link under the log in form." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form title" + }, + "type": { + "type": "AuthTypeEnum", + "required": false, + "description": "The authentication type, `magiclink` or `password`" + }, + "values": { "type": "any", "required": false }, + "view": { + "type": "ViewType", + "required": false, + "description": "Sets the visible authentication form.\nSupported views are:\n- login\n- signup\n- forgot_password\n- update_password\n- otp" + } + }, + "AuthViewOptions": { + "action": { + "type": "AuthActionEnum", + "required": false, + "description": "The submit action, `logIn` or `signUp`" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children are passed down to the underlying form" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render custom elements under the submit button" + }, + "onError": { + "type": "(error: Error) => void", + "required": false, + "description": "Error handler if login or signup fails" + }, + "onSuccess": { + "type": "(data: any) => void", + "required": false, + "description": "Callback executed after succesful login or signup" + }, + "onValidationError": { + "type": "(errors: FieldErrors) => void", + "required": false, + "description": "Callback executed when there are validation errors" + }, + "submitLabel": { + "type": "string", + "defaultValue": "Sign in", + "required": false, + "description": "Label for the submit button" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form title" + }, + "type": { + "type": "AuthTypeEnum", + "required": false, + "description": "The authentication type, `magiclink` or `password`" + } + }, + "ForgotPasswordForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "emailLabel": { "type": "string", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "helpText": { "type": "string", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { "type": "string", "required": false }, + "values": { "type": "Params", "required": false } + }, + "ForgotPasswordView": { + "action": { + "type": "AuthActionEnum", + "required": false, + "description": "The submit action, `logIn` or `signUp`" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children are passed down to the underlying form" + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | { [x: string]: any; email?: string | undefined }", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "emailLabel": { "type": "string", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render custom elements under the submit button" + }, + "formRef": { + "type": "RefObject<\n UseFormReturn\n>", + "required": false, + "description": "The Hook Form state ref." + }, + "helpText": { "type": "string", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "(error: Error) => void", + "required": false, + "description": "Error handler if login or signup fails" + }, + "onSuccess": { + "type": "(data: any) => void", + "required": false, + "description": "Callback executed after succesful login or signup" + }, + "onValidationError": { + "type": "(errors: FieldErrors) => void", + "required": false, + "description": "Callback executed when there are validation errors" + }, + "progressive": { "type": "boolean", "required": false }, + "renderSuccess": { + "type": "(\n data: any\n) => ReactElement>", + "required": false + }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { + "type": "string", + "defaultValue": "Sign in", + "required": false, + "description": "Label for the submit button" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form title" + }, + "type": { + "type": "AuthTypeEnum", + "required": false, + "description": "The authentication type, `magiclink` or `password`" + }, + "values": { "type": "ForgotPasswordSubmitParams", "required": false } + }, + "MagicLinkForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "emailLabel": { "type": "string", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { "type": "string", "required": false }, + "values": { "type": "Params", "required": false } + }, + "OtpForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form children, can be a render prop or a ReactNode." + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "helpText": { "type": "string", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "otpLabel": { "type": "string", "required": false }, + "pinLength": { "type": "number", "required": false }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { "type": "string", "required": false }, + "values": { "type": "Params", "required": false } + }, + "PasswordForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "emailLabel": { "type": "string", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "passwordLabel": { "type": "string", "required": false }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { "type": "string", "required": false }, + "values": { "type": "Params", "required": false } + }, + "Providers": { + "onSignIn": { + "type": "(\n providerId: Extract,\n options: AuthOptions\n) => void", + "required": true, + "description": "The on sign in callback" + }, + "providers": { + "type": "TProviders", + "required": true, + "description": "The available providers" + }, + "labelPrefix": { + "type": "string", + "defaultValue": "'Continue with'", + "required": false, + "description": "The label prefix" + } + }, + "UpdatePasswordForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "confirmLabel": { "type": "string", "required": false }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "helpText": { "type": "string", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "passwordLabel": { "type": "string", "required": false }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { "type": "string", "required": false }, + "values": { "type": "Params", "required": false } + }, + "UpdatePasswordView": { + "action": { + "type": "AuthActionEnum", + "required": false, + "description": "The submit action, `logIn` or `signUp`" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children are passed down to the underlying form" + }, + "confirmLabel": { "type": "string", "required": false }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | {\n [x: string]: any\n password?: string | undefined\n confirmPassword?: string | undefined\n }", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render custom elements under the submit button" + }, + "formRef": { + "type": "RefObject<\n UseFormReturn\n>", + "required": false, + "description": "The Hook Form state ref." + }, + "helpText": { "type": "string", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "(error: Error) => void", + "required": false, + "description": "Error handler if login or signup fails" + }, + "onSuccess": { + "type": "(data: any) => void", + "required": false, + "description": "Callback executed after succesful login or signup" + }, + "onValidationError": { + "type": "(errors: FieldErrors) => void", + "required": false, + "description": "Callback executed when there are validation errors" + }, + "passwordLabel": { "type": "string", "required": false }, + "progressive": { "type": "boolean", "required": false }, + "renderSuccess": { + "type": "(\n data: any\n) => ReactElement>", + "required": false + }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "submitLabel": { + "type": "string", + "defaultValue": "Sign in", + "required": false, + "description": "Label for the submit button" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The form title" + }, + "type": { + "type": "AuthTypeEnum", + "required": false, + "description": "The authentication type, `magiclink` or `password`" + }, + "values": { "type": "UpdatePasswordSubmitParams", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/AuthFormDivider.json b/tooling/props-docs/dist/components/AuthFormDivider.json new file mode 100644 index 000000000..3a4e578f9 --- /dev/null +++ b/tooling/props-docs/dist/components/AuthFormDivider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"AuthFormDivider","methods":[],"props":{"label":{"defaultValue":null,"description":"","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormDividerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormDividerProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/AuthFormSuccess.json b/tooling/props-docs/dist/components/AuthFormSuccess.json new file mode 100644 index 000000000..9b7b36e20 --- /dev/null +++ b/tooling/props-docs/dist/components/AuthFormSuccess.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"AuthFormSuccess","methods":[],"props":{"title":{"defaultValue":null,"description":"","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/success.tsx","name":"AuthFormSuccessProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/success.tsx","name":"AuthFormSuccessProps"}],"required":true,"type":{"name":"ReactNode"}},"description":{"defaultValue":null,"description":"","name":"description","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/success.tsx","name":"AuthFormSuccessProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/success.tsx","name":"AuthFormSuccessProps"}],"required":true,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/AuthProvider.json b/tooling/props-docs/dist/components/AuthProvider.json new file mode 100644 index 000000000..dce1eac75 --- /dev/null +++ b/tooling/props-docs/dist/components/AuthProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"AuthProvider","methods":[],"props":{"onLoadUser":{"defaultValue":{"value":"() => Promise.resolve(null)"},"description":"Loads user data after authentication","name":"onLoadUser","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"(() => Promise)"}},"onSignup":{"defaultValue":{"value":"() => Promise.resolve(null)"},"description":"The signup method","name":"onSignup","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((params: AuthParams, options?: AuthOptions) => Promise) | undefined"}},"onLogin":{"defaultValue":{"value":"() => Promise.resolve(null)"},"description":"The login method","name":"onLogin","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((params: AuthParams, options?: AuthOptions) => Promise) | undefined"}},"onResetPassword":{"defaultValue":null,"description":"Request to reset a password.","name":"onResetPassword","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((params: Required>, options?: AuthOptions) => Promise)"}},"onUpdatePassword":{"defaultValue":null,"description":"Update the password.","name":"onUpdatePassword","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((params: Required>, options?: AuthOptions) => Promise<...>)"}},"onVerifyOtp":{"defaultValue":{"value":"() => Promise.resolve(null)"},"description":"Verify an one time password (2fa)","name":"onVerifyOtp","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((params: OtpParams, options?: AuthOptions) => Promise) | undefined"}},"onLogout":{"defaultValue":{"value":"() => Promise.resolve()"},"description":"The logout method","name":"onLogout","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((options?: AuthOptions) => Promise)"}},"onAuthStateChange":{"defaultValue":null,"description":"Should trigger whenever the authentication state changes","name":"onAuthStateChange","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"((callback: AuthStateChangeCallback) => UnsubscribeHandler)"}},"onGetToken":{"defaultValue":null,"description":"Return the session token","name":"onGetToken","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"AuthProviderProps"}],"required":false,"type":{"name":"(() => Promise)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/AutoFields.json b/tooling/props-docs/dist/components/AutoFields.json new file mode 100644 index 000000000..a82f7d502 --- /dev/null +++ b/tooling/props-docs/dist/components/AutoFields.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"AutoFields","methods":[],"props":{"schema":{"defaultValue":null,"description":"","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"}],"required":false,"type":{"name":"any"}},"fieldResolver":{"defaultValue":null,"description":"","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"}],"required":false,"type":{"name":"FieldResolver"}},"focusFirstField":{"defaultValue":null,"description":"","name":"focusFirstField","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FieldsProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Banner.json b/tooling/props-docs/dist/components/Banner.json new file mode 100644 index 000000000..7cccd581c --- /dev/null +++ b/tooling/props-docs/dist/components/Banner.json @@ -0,0 +1,1083 @@ +{ + "BannerActions": { + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"initial\"\n | \"inherit\"\n | \"-moz-initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + } + }, + "BannerContent": {}, + "BannerDescription": {}, + "BannerIcon": { "icon": { "type": "As", "required": false } }, + "Banner": { + "_dragX": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "_dragY": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "about": { "type": "string", "required": false }, + "accessKey": { "type": "string", "required": false }, + "animate": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | AnimationControls\n | TargetAndTransition\n | VariantLabels", + "required": false, + "description": "Values to animate to, variant label(s), or `AnimationControls`.\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// AnimationControls\n\n```" + }, + "aria-activedescendant": { "type": "string", "required": false }, + "aria-atomic": { "type": "Booleanish", "required": false }, + "aria-autocomplete": { + "type": "\"list\" | \"none\" | \"inline\" | \"both\"", + "required": false + }, + "aria-braillelabel": { "type": "string", "required": false }, + "aria-brailleroledescription": { "type": "string", "required": false }, + "aria-busy": { "type": "Booleanish", "required": false }, + "aria-checked": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-colcount": { "type": "number", "required": false }, + "aria-colindex": { "type": "number", "required": false }, + "aria-colindextext": { "type": "string", "required": false }, + "aria-colspan": { "type": "number", "required": false }, + "aria-controls": { "type": "string", "required": false }, + "aria-current": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"time\"\n | \"page\"\n | \"true\"\n | \"false\"\n | \"step\"\n | \"location\"\n | \"date\"", + "required": false + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-description": { "type": "string", "required": false }, + "aria-details": { "type": "string", "required": false }, + "aria-disabled": { "type": "Booleanish", "required": false }, + "aria-dropeffect": { + "type": "\"link\" | \"none\" | \"copy\" | \"move\" | \"execute\" | \"popup\"", + "required": false + }, + "aria-errormessage": { "type": "string", "required": false }, + "aria-expanded": { "type": "Booleanish", "required": false }, + "aria-flowto": { "type": "string", "required": false }, + "aria-grabbed": { "type": "Booleanish", "required": false }, + "aria-haspopup": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"dialog\"\n | \"menu\"\n | \"grid\"\n | \"true\"\n | \"false\"\n | \"listbox\"\n | \"tree\"", + "required": false + }, + "aria-hidden": { "type": "Booleanish", "required": false }, + "aria-invalid": { + "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", + "required": false + }, + "aria-keyshortcuts": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "aria-level": { "type": "number", "required": false }, + "aria-live": { + "type": "\"off\" | \"assertive\" | \"polite\"", + "required": false + }, + "aria-modal": { "type": "Booleanish", "required": false }, + "aria-multiline": { "type": "Booleanish", "required": false }, + "aria-multiselectable": { "type": "Booleanish", "required": false }, + "aria-orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "aria-owns": { "type": "string", "required": false }, + "aria-placeholder": { "type": "string", "required": false }, + "aria-posinset": { "type": "number", "required": false }, + "aria-pressed": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-readonly": { "type": "Booleanish", "required": false }, + "aria-relevant": { + "type": "type ONLY_FOR_FORMAT =\n | \"text\"\n | \"all\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", + "required": false + }, + "aria-required": { "type": "Booleanish", "required": false }, + "aria-roledescription": { "type": "string", "required": false }, + "aria-rowcount": { "type": "number", "required": false }, + "aria-rowindex": { "type": "number", "required": false }, + "aria-rowindextext": { "type": "string", "required": false }, + "aria-rowspan": { "type": "number", "required": false }, + "aria-selected": { "type": "Booleanish", "required": false }, + "aria-setsize": { "type": "number", "required": false }, + "aria-sort": { + "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", + "required": false + }, + "aria-valuemax": { "type": "number", "required": false }, + "aria-valuemin": { "type": "number", "required": false }, + "aria-valuenow": { "type": "number", "required": false }, + "aria-valuetext": { "type": "string", "required": false }, + "autoCapitalize": { "type": "string", "required": false }, + "autoCorrect": { "type": "string", "required": false }, + "autoFocus": { "type": "boolean", "required": false }, + "autoSave": { "type": "string", "required": false }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | MotionValue<...> | MotionValue<...>", + "required": false + }, + "className": { "type": "string", "required": false }, + "content": { "type": "string", "required": false }, + "contentEditable": { + "type": "\"inherit\" | Booleanish", + "required": false + }, + "contextMenu": { "type": "string", "required": false }, + "custom": { + "type": "any", + "required": false, + "description": "Custom data to use to resolve dynamic variants differently for each animating component.\n\n```jsx\nconst variants = {\n visible: (custom) => ({\n opacity: 1,\n transition: { delay: custom * 0.2 }\n })\n}\n\n\n\n\n```" + }, + "dangerouslySetInnerHTML": { + "type": "{ __html: string | TrustedHTML }", + "required": false + }, + "datatype": { "type": "string", "required": false }, + "defaultChecked": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | number | readonly string[]", + "required": false + }, + "dir": { "type": "string", "required": false }, + "drag": { + "type": "boolean | \"x\" | \"y\"", + "required": false, + "description": "Enable dragging for this element. Set to `false` by default.\nSet `true` to drag in both directions.\nSet `\"x\"` or `\"y\"` to only drag in a specific direction.\n\n```jsx\n\n```" + }, + "dragConstraints": { + "type": "false | Partial | RefObject", + "required": false, + "description": "Applies constraints on the permitted draggable area.\n\nIt can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels.\nThis will define a distance the named edge of the draggable component.\n\nAlternatively, it can accept a `ref` to another component created with React's `useRef` hook.\nThis `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref`\nof the component you want to use as constraints.\n\n```jsx\n// In pixels\n\n\n// As a ref to another component\nconst MyComponent = () => {\n const constraintsRef = useRef(null)\n\n return (\n \n \n \n )\n}\n```" + }, + "dragControls": { + "type": "DragControls", + "required": false, + "description": "Usually, dragging is initiated by pressing down on a component and moving it. For some\nuse-cases, for instance clicking at an arbitrary point on a video scrubber, we\nmight want to initiate dragging from a different component than the draggable one.\n\nBy creating a `dragControls` using the `useDragControls` hook, we can pass this into\nthe draggable component's `dragControls` prop. It exposes a `start` method\nthat can start dragging from pointer events on other components.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragDirectionLock": { + "type": "boolean", + "required": false, + "description": "If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n\n```jsx\n\n```" + }, + "dragElastic": { + "type": "DragElastic", + "required": false, + "description": "The degree of movement allowed outside constraints. 0 = no movement, 1 =\nfull movement.\n\nSet to `0.5` by default. Can also be set as `false` to disable movement.\n\nBy passing an object of `top`/`right`/`bottom`/`left`, individual values can be set\nper constraint. Any missing values will be set to `0`.\n\n```jsx\n\n```" + }, + "draggable": { "type": "Booleanish", "required": false }, + "dragListener": { + "type": "boolean", + "required": false, + "description": "By default, if `drag` is defined on a component then an event listener will be attached\nto automatically initiate dragging when a user presses down on it.\n\nBy setting `dragListener` to `false`, this event listener will not be created.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragMomentum": { + "type": "boolean", + "required": false, + "description": "Apply momentum from the pan gesture to the component when dragging\nfinishes. Set to `true` by default.\n\n```jsx\n\n```" + }, + "dragPropagation": { + "type": "boolean", + "required": false, + "description": "Allows drag gesture propagation to child components. Set to `false` by\ndefault.\n\n```jsx\n\n```" + }, + "dragSnapToOrigin": { + "type": "boolean", + "required": false, + "description": "If true, element will snap back to its origin when dragging ends.\n\nEnabling this is the equivalent of setting all `dragConstraints` axes to `0`\nwith `dragElastic={1}`, but when used together `dragConstraints` can define\na wider draggable area and `dragSnapToOrigin` will ensure the element\nanimates back to its origin on release." + }, + "dragTransition": { + "type": "Partial>", + "required": false, + "description": "Allows you to change dragging inertia parameters.\nWhen releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it.\nSee \n{@link \nhttps://framer.com/api/animation/#inertia Inertia\n}\n for all properties you can use.\n\n```jsx\n\n```" + }, + "exit": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "A target to animate to when this component is removed from the tree.\n\nThis component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n\nThis limitation exists because React doesn't allow components to defer unmounting until after\nan animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n\n```jsx\nimport { AnimatePresence, motion } from 'framer-motion'\n\nexport const MyComponent = ({ isVisible }) => {\n return (\n \n {isVisible && (\n \n )}\n \n )\n}\n```" + }, + "hidden": { "type": "boolean", "required": false }, + "id": { "type": "string", "required": false }, + "ignoreStrict": { "type": "boolean", "required": false }, + "inherit": { "type": "boolean", "required": false }, + "initial": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | MakeCustomValueType\n | VariantLabels", + "required": false, + "description": "Properties, variant label or array of variant labels to start in.\n\nSet to `false` to initialise with the values in `animate` (disabling the mount animation)\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// As false (disable mount animation)\n\n```" + }, + "inlist": { "type": "any", "required": false }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"text\"\n | \"none\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"", + "required": false + }, + "is": { "type": "string", "required": false }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Show or hide the banner." + }, + "itemID": { "type": "string", "required": false }, + "itemProp": { "type": "string", "required": false }, + "itemRef": { "type": "string", "required": false }, + "itemScope": { "type": "boolean", "required": false }, + "itemType": { "type": "string", "required": false }, + "lang": { "type": "string", "required": false }, + "layout": { + "type": "boolean | \"position\" | \"size\" | \"preserve-aspect\"", + "required": false, + "description": "If `true`, this component will automatically animate to its new position when\nits layout changes.\n\n```jsx\n\n```\n\nThis will perform a layout animation using performant transforms. Part of this technique\ninvolved animating an element's scale. This can introduce visual distortions on children,\n`boxShadow` and `borderRadius`.\n\nTo correct distortion on immediate children, add `layout` to those too.\n\n`boxShadow` and `borderRadius` will automatically be corrected if they are already being\nanimated on this component. Otherwise, set them directly via the `initial` prop.\n\nIf `layout` is set to `\"position\"`, the size of the component will change instantly and\nonly its position will animate. If `layout` is set to `\"size\"`, the position of the\ncomponent will change instantly but its size will animate.\n\nIf `layout` is set to `\"size\"`, the position of the component will change instantly and\nonly its size will animate.\n\nIf `layout` is set to `\"preserve-aspect\"`, the component will animate size & position if\nthe aspect ratio remains the same between renders, and just position if the ratio changes." + }, + "layoutDependency": { "type": "any", "required": false }, + "layoutId": { + "type": "string", + "required": false, + "description": "Enable shared layout transitions between different components with the same `layoutId`.\n\nWhen a component with a layoutId is removed from the React tree, and then\nadded elsewhere, it will visually animate from the previous component's bounding box\nand its latest animated values.\n\n```jsx\n {items.map(item => (\n \n {item.name}\n {item.isSelected && }\n \n ))}\n```\n\nIf the previous component remains in the tree it will crossfade with the new component." + }, + "layoutRoot": { + "type": "boolean", + "required": false, + "description": "Whether an element should be considered a \"layout root\", where\nall children will be forced to resolve relatively to it.\nCurrently used for `position: sticky` elements in Framer." + }, + "layoutScroll": { + "type": "boolean", + "required": false, + "description": "Whether a projection node should measure its scroll when it or its descendants update their layout." + }, + "motionPreset": { + "type": "BannerMotion", + "defaultValue": "'slideOutTop'", + "required": false, + "description": "Customize the close animation." + }, + "nonce": { "type": "string", "required": false }, + "onAbort": { + "type": "ReactEventHandler", + "required": false + }, + "onAbortCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onAnimationComplete": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` is complete.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has completed.\n\n```jsx\nfunction onComplete() {\n console.log(\"Animation completed\")\n}\n\n {\n console.log('Completed animating', definition)\n }}\n/>\n```" + }, + "onAnimationEnd": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationEndCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIteration": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIterationCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onAnimationStartCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAuxClick": { + "type": "MouseEventHandler", + "required": false + }, + "onAuxClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onBeforeInput": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeLayoutMeasure": { + "type": "(box: Box) => void", + "required": false + }, + "onBlur": { + "type": "FocusEventHandler", + "required": false + }, + "onBlurCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onCanPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThrough": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThroughCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onChange": { + "type": "FormEventHandler", + "required": false + }, + "onChangeCapture": { + "type": "FormEventHandler", + "required": false + }, + "onClick": { + "type": "MouseEventHandler", + "required": false + }, + "onClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the close button is clicked." + }, + "onCompositionEnd": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionEndCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStart": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStartCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdate": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdateCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onContextMenu": { + "type": "MouseEventHandler", + "required": false + }, + "onContextMenuCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCopy": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCopyCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCut": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCutCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onDirectionLock": { + "type": "(axis: \"x\" | \"y\") => void", + "required": false, + "description": "Callback function that fires a drag direction is determined.\n\n```jsx\n console.log(axis)}\n/>\n```" + }, + "onDoubleClick": { + "type": "MouseEventHandler", + "required": false + }, + "onDoubleClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEndCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnter": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnterCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragExit": { + "type": "DragEventHandler", + "required": false + }, + "onDragExitCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeave": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeaveCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragOver": { + "type": "DragEventHandler", + "required": false + }, + "onDragOverCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStartCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragTransitionEnd": { + "type": "() => void", + "required": false, + "description": "Callback function that fires when drag momentum/bounce transition finishes.\n\n```jsx\n console.log('Drag transition complete')}\n/>\n```" + }, + "onDrop": { "type": "DragEventHandler", "required": false }, + "onDropCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDurationChange": { + "type": "ReactEventHandler", + "required": false + }, + "onDurationChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptied": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptiedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEncrypted": { + "type": "ReactEventHandler", + "required": false + }, + "onEncryptedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEnded": { + "type": "ReactEventHandler", + "required": false + }, + "onEndedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onError": { + "type": "ReactEventHandler", + "required": false + }, + "onErrorCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onFocus": { + "type": "FocusEventHandler", + "required": false + }, + "onFocusCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onGotPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onGotPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onHoverEnd": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer stops hovering over the component.\n\n```jsx\n console.log(\"Hover ends\")} />\n```" + }, + "onHoverStart": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer starts hovering over the component.\n\n```jsx\n console.log('Hover starts')} />\n```" + }, + "onInput": { + "type": "FormEventHandler", + "required": false + }, + "onInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onInvalid": { + "type": "FormEventHandler", + "required": false + }, + "onInvalidCapture": { + "type": "FormEventHandler", + "required": false + }, + "onKeyDown": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyDownCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPress": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPressCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUp": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUpCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onLayoutAnimationComplete": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component completes." + }, + "onLayoutAnimationStart": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component starts." + }, + "onLayoutMeasure": { + "type": "(box: Box, prevBox: Box) => void", + "required": false + }, + "onLoad": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedData": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedDataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadata": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStart": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStartCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLostPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onLostPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onMeasureDragConstraints": { + "type": "(constraints: BoundingBox) => void | BoundingBox", + "required": false, + "description": "If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints." + }, + "onMouseDown": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseDownCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseEnter": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseLeave": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMove": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMoveCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOut": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOutCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOver": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOverCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUp": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUpCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onPan": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture is recognised on this element.\n\n**Note:** For pan gestures to work correctly with touch input, the element needs\ntouch scrolling to be disabled on either x/y or both axis with the\n[touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) CSS rule.\n\n```jsx\nfunction onPan(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanEnd": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture ends on this element.\n\n```jsx\nfunction onPanEnd(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanSessionStart": { + "type": "(event: PointerEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when we begin detecting a pan gesture. This\nis analogous to `onMouseStart` or `onTouchStart`.\n\n```jsx\nfunction onPanSessionStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanStart": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture begins on this element.\n\n```jsx\nfunction onPanStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPaste": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPasteCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPause": { + "type": "ReactEventHandler", + "required": false + }, + "onPauseCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlaying": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPointerCancel": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerCancelCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDown": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDownCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnter": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnterCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeave": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeaveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMove": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMoveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOut": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOutCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOver": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOverCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUp": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUpCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onProgress": { + "type": "ReactEventHandler", + "required": false + }, + "onProgressCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChange": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onReset": { + "type": "FormEventHandler", + "required": false + }, + "onResetCapture": { + "type": "FormEventHandler", + "required": false + }, + "onResize": { + "type": "ReactEventHandler", + "required": false + }, + "onResizeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onScroll": { "type": "UIEventHandler", "required": false }, + "onScrollCapture": { + "type": "UIEventHandler", + "required": false + }, + "onSeeked": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSeeking": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSelect": { + "type": "ReactEventHandler", + "required": false + }, + "onSelectCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onStalled": { + "type": "ReactEventHandler", + "required": false + }, + "onStalledCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSubmit": { + "type": "FormEventHandler", + "required": false + }, + "onSubmitCapture": { + "type": "FormEventHandler", + "required": false + }, + "onSuspend": { + "type": "ReactEventHandler", + "required": false + }, + "onSuspendCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTap": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture successfully ends on this element.\n\n```jsx\nfunction onTap(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapCancel": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture ends outside this element.\n\n```jsx\nfunction onTapCancel(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture starts on this element.\n\n```jsx\nfunction onTapStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTimeUpdate": { + "type": "ReactEventHandler", + "required": false + }, + "onTimeUpdateCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTouchCancel": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchCancelCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEnd": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEndCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMove": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMoveCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStart": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStartCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTransitionEnd": { + "type": "TransitionEventHandler", + "required": false + }, + "onTransitionEndCapture": { + "type": "TransitionEventHandler", + "required": false + }, + "onUpdate": { + "type": "(latest: ResolvedValues) => void", + "required": false, + "description": "Callback with latest motion values, fired max once per frame.\n\n```jsx\nfunction onUpdate(latest) {\n console.log(latest.x, latest.opacity)\n}\n\n\n```" + }, + "onViewportEnter": { "type": "ViewportEventHandler", "required": false }, + "onViewportLeave": { "type": "ViewportEventHandler", "required": false }, + "onVolumeChange": { + "type": "ReactEventHandler", + "required": false + }, + "onVolumeChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWaiting": { + "type": "ReactEventHandler", + "required": false + }, + "onWaitingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWheel": { + "type": "WheelEventHandler", + "required": false + }, + "onWheelCapture": { + "type": "WheelEventHandler", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "prefix": { "type": "string", "required": false }, + "property": { "type": "string", "required": false }, + "radioGroup": { "type": "string", "required": false }, + "rel": { "type": "string", "required": false }, + "resource": { "type": "string", "required": false }, + "results": { "type": "number", "required": false }, + "rev": { "type": "string", "required": false }, + "role": { "type": "AriaRole", "required": false }, + "security": { "type": "string", "required": false }, + "slot": { "type": "string", "required": false }, + "spellCheck": { "type": "Booleanish", "required": false }, + "status": { + "type": "\"info\" | \"warning\" | \"success\" | \"error\"", + "required": false, + "description": "The status of the banner." + }, + "style": { + "type": "MotionStyle", + "required": false, + "description": "\nThe React DOM `style` prop, enhanced with support for `MotionValue`s and separate `transform` values.\n\n```jsx\nexport const MyComponent = () => {\n const x = useMotionValue(0)\n\n return \n}\n```" + }, + "suppressContentEditableWarning": { "type": "boolean", "required": false }, + "suppressHydrationWarning": { "type": "boolean", "required": false }, + "tabIndex": { "type": "number", "required": false }, + "title": { "type": "string", "required": false }, + "transformTemplate": { + "type": "(\n transform: TransformProperties,\n generatedTransform: string\n) => string", + "required": false, + "description": "By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate`\ncan be used to create a different order, or to append/preprend the automatically generated `transform` property.\n\n```jsx\n `rotate(${rotate}deg) translateX(${x}px)`\n }\n/>\n```" + }, + "transformValues": { + "type": "(values: V) => V", + "required": false, + "description": "Internal.\n\nThis allows values to be transformed before being animated or set as styles.\n\nFor instance, this allows custom values in Framer Library like `size` to be converted into `width` and `height`.\nIt also allows us a chance to take a value like `Color` and convert it to an animatable color string.\n\nA few structural typing changes need making before this can be a public property:\n- Allow `Target` values to be appended by user-defined types (delete `CustomStyles` - does `size` throw a type error?)\n- Extract `CustomValueType` as a separate user-defined type (delete `CustomValueType` and animate a `Color` - does this throw a type error?)." + }, + "translate": { "type": "\"yes\" | \"no\"", "required": false }, + "typeof": { "type": "string", "required": false }, + "unselectable": { "type": "\"on\" | \"off\"", "required": false }, + "variants": { + "type": "Variants", + "required": false, + "description": "Variants allow you to define animation states and organise them by name. They allow\nyou to control animations throughout a component tree by switching a single `animate` prop.\n\nUsing `transition` options like `delayChildren` and `staggerChildren`, you can orchestrate\nwhen children animations play relative to their parent.\n\n\nAfter passing variants to one or more `motion` component's `variants` prop, these variants\ncan be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n\n```jsx\nconst variants = {\n active: {\n backgroundColor: \"#f00\"\n },\n inactive: {\n backgroundColor: \"#fff\",\n transition: { duration: 2 }\n }\n}\n\n\n```" + }, + "viewport": { "type": "ViewportOptions", "required": false }, + "vocab": { "type": "string", "required": false }, + "whileDrag": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the drag gesture is recognised.\n\n```jsx\n\n```" + }, + "whileFocus": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the focus gesture is recognised.\n\n```jsx\n\n```" + }, + "whileHover": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the hover gesture is recognised.\n\n```jsx\n\n```" + }, + "whileInView": { + "type": "TargetAndTransition | VariantLabels", + "required": false + }, + "whileTap": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the component is pressed.\n\n```jsx\n\n```" + } + }, + "BannerTitle": {} +} diff --git a/tooling/props-docs/dist/components/BannerActions.json b/tooling/props-docs/dist/components/BannerActions.json new file mode 100644 index 000000000..dffbddcc1 --- /dev/null +++ b/tooling/props-docs/dist/components/BannerActions.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The banner actions, renders a ButtonGroup.","displayName":"BannerActions","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BannerCloseButton.json b/tooling/props-docs/dist/components/BannerCloseButton.json new file mode 100644 index 000000000..c47aa156a --- /dev/null +++ b/tooling/props-docs/dist/components/BannerCloseButton.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The close button.","displayName":"BannerCloseButton","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BannerContent.json b/tooling/props-docs/dist/components/BannerContent.json new file mode 100644 index 000000000..21093c0c8 --- /dev/null +++ b/tooling/props-docs/dist/components/BannerContent.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The wrapper for the banner title and description.","displayName":"BannerContent","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BannerDescription.json b/tooling/props-docs/dist/components/BannerDescription.json new file mode 100644 index 000000000..9c7e2ce4f --- /dev/null +++ b/tooling/props-docs/dist/components/BannerDescription.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The description of the banner to be announced by screen readers.","displayName":"BannerDescription","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BannerIcon.json b/tooling/props-docs/dist/components/BannerIcon.json new file mode 100644 index 000000000..8369bc4d1 --- /dev/null +++ b/tooling/props-docs/dist/components/BannerIcon.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The visual icon for the banner.","displayName":"BannerIcon","methods":[],"props":{"icon":{"defaultValue":null,"description":"","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"BannerIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"BannerIconProps"}],"required":false,"type":{"name":"As"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BannerTitle.json b/tooling/props-docs/dist/components/BannerTitle.json new file mode 100644 index 000000000..e1fc46411 --- /dev/null +++ b/tooling/props-docs/dist/components/BannerTitle.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/banner"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The title of the banner to be announced by screen readers.","displayName":"BannerTitle","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BaseDrawer.json b/tooling/props-docs/dist/components/BaseDrawer.json new file mode 100644 index 000000000..e5171a3c8 --- /dev/null +++ b/tooling/props-docs/dist/components/BaseDrawer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"BaseDrawer","methods":[],"props":{"title":{"defaultValue":null,"description":"The drawer title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":true,"type":{"name":"ReactNode"}},"children":{"defaultValue":null,"description":"The modal children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":true,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; onClose: () => void; }>"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overflow","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BaseField.json b/tooling/props-docs/dist/components/BaseField.json new file mode 100644 index 000000000..a317b6a10 --- /dev/null +++ b/tooling/props-docs/dist/components/BaseField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The default BaseField component\nComposes the Chakra UI FormControl component, with FormLabel, FormHelperText and FormErrorMessage.","displayName":"BaseField","methods":[],"props":{"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":true,"type":{"name":"string"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BaseModal.json b/tooling/props-docs/dist/components/BaseModal.json new file mode 100644 index 000000000..17d18c9ad --- /dev/null +++ b/tooling/props-docs/dist/components/BaseModal.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"BaseModal","methods":[],"props":{"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"children":{"defaultValue":null,"description":"The modal children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":true,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; onClose: () => void; }>"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/BulkActions.json b/tooling/props-docs/dist/components/BulkActions.json new file mode 100644 index 000000000..5077d99e2 --- /dev/null +++ b/tooling/props-docs/dist/components/BulkActions.json @@ -0,0 +1,1070 @@ +{ + "BulkActions": { + "selections": { + "type": "BulkActionsSelections", + "required": true, + "description": "Array with selected ids." + }, + "_dragX": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "_dragY": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "about": { "type": "string", "required": false }, + "accessKey": { "type": "string", "required": false }, + "animate": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | VariantLabels\n | AnimationControls\n | TargetAndTransition", + "required": false, + "description": "Values to animate to, variant label(s), or `AnimationControls`.\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// AnimationControls\n\n```" + }, + "aria-activedescendant": { "type": "string", "required": false }, + "aria-atomic": { "type": "Booleanish", "required": false }, + "aria-autocomplete": { + "type": "\"list\" | \"none\" | \"inline\" | \"both\"", + "required": false + }, + "aria-braillelabel": { "type": "string", "required": false }, + "aria-brailleroledescription": { "type": "string", "required": false }, + "aria-busy": { "type": "Booleanish", "required": false }, + "aria-checked": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-colcount": { "type": "number", "required": false }, + "aria-colindex": { "type": "number", "required": false }, + "aria-colindextext": { "type": "string", "required": false }, + "aria-colspan": { "type": "number", "required": false }, + "aria-controls": { "type": "string", "required": false }, + "aria-current": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"time\"\n | \"true\"\n | \"false\"\n | \"page\"\n | \"step\"\n | \"location\"\n | \"date\"", + "required": false + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-description": { "type": "string", "required": false }, + "aria-details": { "type": "string", "required": false }, + "aria-disabled": { "type": "Booleanish", "required": false }, + "aria-dropeffect": { + "type": "\"link\" | \"none\" | \"copy\" | \"move\" | \"execute\" | \"popup\"", + "required": false + }, + "aria-errormessage": { "type": "string", "required": false }, + "aria-expanded": { "type": "Booleanish", "required": false }, + "aria-flowto": { "type": "string", "required": false }, + "aria-grabbed": { "type": "Booleanish", "required": false }, + "aria-haspopup": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"dialog\"\n | \"menu\"\n | \"true\"\n | \"false\"\n | \"grid\"\n | \"listbox\"\n | \"tree\"", + "required": false + }, + "aria-hidden": { "type": "Booleanish", "required": false }, + "aria-invalid": { + "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", + "required": false + }, + "aria-keyshortcuts": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "aria-level": { "type": "number", "required": false }, + "aria-live": { + "type": "\"off\" | \"assertive\" | \"polite\"", + "required": false + }, + "aria-modal": { "type": "Booleanish", "required": false }, + "aria-multiline": { "type": "Booleanish", "required": false }, + "aria-multiselectable": { "type": "Booleanish", "required": false }, + "aria-orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "aria-owns": { "type": "string", "required": false }, + "aria-placeholder": { "type": "string", "required": false }, + "aria-posinset": { "type": "number", "required": false }, + "aria-pressed": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-readonly": { "type": "Booleanish", "required": false }, + "aria-relevant": { + "type": "type ONLY_FOR_FORMAT =\n | \"text\"\n | \"all\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", + "required": false + }, + "aria-required": { "type": "Booleanish", "required": false }, + "aria-roledescription": { "type": "string", "required": false }, + "aria-rowcount": { "type": "number", "required": false }, + "aria-rowindex": { "type": "number", "required": false }, + "aria-rowindextext": { "type": "string", "required": false }, + "aria-rowspan": { "type": "number", "required": false }, + "aria-selected": { "type": "Booleanish", "required": false }, + "aria-setsize": { "type": "number", "required": false }, + "aria-sort": { + "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", + "required": false + }, + "aria-valuemax": { "type": "number", "required": false }, + "aria-valuemin": { "type": "number", "required": false }, + "aria-valuenow": { "type": "number", "required": false }, + "aria-valuetext": { "type": "string", "required": false }, + "autoCapitalize": { "type": "string", "required": false }, + "autoCorrect": { "type": "string", "required": false }, + "autoFocus": { "type": "boolean", "required": false }, + "autoSave": { "type": "string", "required": false }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The action buttons." + }, + "className": { "type": "string", "required": false }, + "content": { "type": "string", "required": false }, + "contentEditable": { + "type": "\"inherit\" | Booleanish", + "required": false + }, + "contextMenu": { "type": "string", "required": false }, + "custom": { + "type": "any", + "required": false, + "description": "Custom data to use to resolve dynamic variants differently for each animating component.\n\n```jsx\nconst variants = {\n visible: (custom) => ({\n opacity: 1,\n transition: { delay: custom * 0.2 }\n })\n}\n\n\n\n\n```" + }, + "dangerouslySetInnerHTML": { + "type": "{ __html: string | TrustedHTML }", + "required": false + }, + "datatype": { "type": "string", "required": false }, + "defaultChecked": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | number | readonly string[]", + "required": false + }, + "dir": { "type": "string", "required": false }, + "drag": { + "type": "boolean | \"x\" | \"y\"", + "required": false, + "description": "Enable dragging for this element. Set to `false` by default.\nSet `true` to drag in both directions.\nSet `\"x\"` or `\"y\"` to only drag in a specific direction.\n\n```jsx\n\n```" + }, + "dragConstraints": { + "type": "false | Partial | RefObject", + "required": false, + "description": "Applies constraints on the permitted draggable area.\n\nIt can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels.\nThis will define a distance the named edge of the draggable component.\n\nAlternatively, it can accept a `ref` to another component created with React's `useRef` hook.\nThis `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref`\nof the component you want to use as constraints.\n\n```jsx\n// In pixels\n\n\n// As a ref to another component\nconst MyComponent = () => {\n const constraintsRef = useRef(null)\n\n return (\n \n \n \n )\n}\n```" + }, + "dragControls": { + "type": "DragControls", + "required": false, + "description": "Usually, dragging is initiated by pressing down on a component and moving it. For some\nuse-cases, for instance clicking at an arbitrary point on a video scrubber, we\nmight want to initiate dragging from a different component than the draggable one.\n\nBy creating a `dragControls` using the `useDragControls` hook, we can pass this into\nthe draggable component's `dragControls` prop. It exposes a `start` method\nthat can start dragging from pointer events on other components.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragDirectionLock": { + "type": "boolean", + "required": false, + "description": "If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n\n```jsx\n\n```" + }, + "dragElastic": { + "type": "DragElastic", + "required": false, + "description": "The degree of movement allowed outside constraints. 0 = no movement, 1 =\nfull movement.\n\nSet to `0.5` by default. Can also be set as `false` to disable movement.\n\nBy passing an object of `top`/`right`/`bottom`/`left`, individual values can be set\nper constraint. Any missing values will be set to `0`.\n\n```jsx\n\n```" + }, + "draggable": { "type": "Booleanish", "required": false }, + "dragListener": { + "type": "boolean", + "required": false, + "description": "By default, if `drag` is defined on a component then an event listener will be attached\nto automatically initiate dragging when a user presses down on it.\n\nBy setting `dragListener` to `false`, this event listener will not be created.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragMomentum": { + "type": "boolean", + "required": false, + "description": "Apply momentum from the pan gesture to the component when dragging\nfinishes. Set to `true` by default.\n\n```jsx\n\n```" + }, + "dragPropagation": { + "type": "boolean", + "required": false, + "description": "Allows drag gesture propagation to child components. Set to `false` by\ndefault.\n\n```jsx\n\n```" + }, + "dragSnapToOrigin": { + "type": "boolean", + "required": false, + "description": "If true, element will snap back to its origin when dragging ends.\n\nEnabling this is the equivalent of setting all `dragConstraints` axes to `0`\nwith `dragElastic={1}`, but when used together `dragConstraints` can define\na wider draggable area and `dragSnapToOrigin` will ensure the element\nanimates back to its origin on release." + }, + "dragTransition": { + "type": "Partial>", + "required": false, + "description": "Allows you to change dragging inertia parameters.\nWhen releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it.\nSee \n{@link \nhttps://framer.com/api/animation/#inertia Inertia\n}\n for all properties you can use.\n\n```jsx\n\n```" + }, + "exit": { + "type": "VariantLabels | TargetAndTransition", + "required": false, + "description": "A target to animate to when this component is removed from the tree.\n\nThis component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n\nThis limitation exists because React doesn't allow components to defer unmounting until after\nan animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n\n```jsx\nimport { AnimatePresence, motion } from 'framer-motion'\n\nexport const MyComponent = ({ isVisible }) => {\n return (\n \n {isVisible && (\n \n )}\n \n )\n}\n```" + }, + "hidden": { "type": "boolean", "required": false }, + "id": { "type": "string", "required": false }, + "ignoreStrict": { "type": "boolean", "required": false }, + "inherit": { "type": "boolean", "required": false }, + "initial": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | MakeCustomValueType\n | VariantLabels", + "required": false, + "description": "Properties, variant label or array of variant labels to start in.\n\nSet to `false` to initialise with the values in `animate` (disabling the mount animation)\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// As false (disable mount animation)\n\n```" + }, + "inlist": { "type": "any", "required": false }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"none\"\n | \"text\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"", + "required": false + }, + "is": { "type": "string", "required": false }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Show or hide the banner." + }, + "itemID": { "type": "string", "required": false }, + "itemProp": { "type": "string", "required": false }, + "itemRef": { "type": "string", "required": false }, + "itemScope": { "type": "boolean", "required": false }, + "itemType": { "type": "string", "required": false }, + "lang": { "type": "string", "required": false }, + "layout": { + "type": "boolean | \"position\" | \"size\" | \"preserve-aspect\"", + "required": false, + "description": "If `true`, this component will automatically animate to its new position when\nits layout changes.\n\n```jsx\n\n```\n\nThis will perform a layout animation using performant transforms. Part of this technique\ninvolved animating an element's scale. This can introduce visual distortions on children,\n`boxShadow` and `borderRadius`.\n\nTo correct distortion on immediate children, add `layout` to those too.\n\n`boxShadow` and `borderRadius` will automatically be corrected if they are already being\nanimated on this component. Otherwise, set them directly via the `initial` prop.\n\nIf `layout` is set to `\"position\"`, the size of the component will change instantly and\nonly its position will animate. If `layout` is set to `\"size\"`, the position of the\ncomponent will change instantly but its size will animate.\n\nIf `layout` is set to `\"size\"`, the position of the component will change instantly and\nonly its size will animate.\n\nIf `layout` is set to `\"preserve-aspect\"`, the component will animate size & position if\nthe aspect ratio remains the same between renders, and just position if the ratio changes." + }, + "layoutDependency": { "type": "any", "required": false }, + "layoutId": { + "type": "string", + "required": false, + "description": "Enable shared layout transitions between different components with the same `layoutId`.\n\nWhen a component with a layoutId is removed from the React tree, and then\nadded elsewhere, it will visually animate from the previous component's bounding box\nand its latest animated values.\n\n```jsx\n {items.map(item => (\n \n {item.name}\n {item.isSelected && }\n \n ))}\n```\n\nIf the previous component remains in the tree it will crossfade with the new component." + }, + "layoutRoot": { + "type": "boolean", + "required": false, + "description": "Whether an element should be considered a \"layout root\", where\nall children will be forced to resolve relatively to it.\nCurrently used for `position: sticky` elements in Framer." + }, + "layoutScroll": { + "type": "boolean", + "required": false, + "description": "Whether a projection node should measure its scroll when it or its descendants update their layout." + }, + "motionPreset": { + "type": "BannerMotion", + "defaultValue": "'slideOutTop'", + "required": false, + "description": "Customize the close animation." + }, + "nonce": { "type": "string", "required": false }, + "onAbort": { + "type": "ReactEventHandler", + "required": false + }, + "onAbortCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onAnimationComplete": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` is complete.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has completed.\n\n```jsx\nfunction onComplete() {\n console.log(\"Animation completed\")\n}\n\n {\n console.log('Completed animating', definition)\n }}\n/>\n```" + }, + "onAnimationEnd": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationEndCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIteration": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIterationCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onAnimationStartCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAuxClick": { + "type": "MouseEventHandler", + "required": false + }, + "onAuxClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onBeforeInput": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeLayoutMeasure": { + "type": "(box: Box) => void", + "required": false + }, + "onBlur": { + "type": "FocusEventHandler", + "required": false + }, + "onBlurCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onCanPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThrough": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThroughCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onChange": { + "type": "FormEventHandler", + "required": false + }, + "onChangeCapture": { + "type": "FormEventHandler", + "required": false + }, + "onClick": { + "type": "MouseEventHandler", + "required": false + }, + "onClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the close button is clicked." + }, + "onCompositionEnd": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionEndCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStart": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStartCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdate": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdateCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onContextMenu": { + "type": "MouseEventHandler", + "required": false + }, + "onContextMenuCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCopy": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCopyCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCut": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCutCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onDirectionLock": { + "type": "(axis: \"x\" | \"y\") => void", + "required": false, + "description": "Callback function that fires a drag direction is determined.\n\n```jsx\n console.log(axis)}\n/>\n```" + }, + "onDoubleClick": { + "type": "MouseEventHandler", + "required": false + }, + "onDoubleClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEndCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnter": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnterCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragExit": { + "type": "DragEventHandler", + "required": false + }, + "onDragExitCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeave": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeaveCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragOver": { + "type": "DragEventHandler", + "required": false + }, + "onDragOverCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStartCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragTransitionEnd": { + "type": "() => void", + "required": false, + "description": "Callback function that fires when drag momentum/bounce transition finishes.\n\n```jsx\n console.log('Drag transition complete')}\n/>\n```" + }, + "onDrop": { "type": "DragEventHandler", "required": false }, + "onDropCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDurationChange": { + "type": "ReactEventHandler", + "required": false + }, + "onDurationChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptied": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptiedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEncrypted": { + "type": "ReactEventHandler", + "required": false + }, + "onEncryptedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEnded": { + "type": "ReactEventHandler", + "required": false + }, + "onEndedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onError": { + "type": "ReactEventHandler", + "required": false + }, + "onErrorCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onFocus": { + "type": "FocusEventHandler", + "required": false + }, + "onFocusCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onGotPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onGotPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onHoverEnd": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer stops hovering over the component.\n\n```jsx\n console.log(\"Hover ends\")} />\n```" + }, + "onHoverStart": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer starts hovering over the component.\n\n```jsx\n console.log('Hover starts')} />\n```" + }, + "onInput": { + "type": "FormEventHandler", + "required": false + }, + "onInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onInvalid": { + "type": "FormEventHandler", + "required": false + }, + "onInvalidCapture": { + "type": "FormEventHandler", + "required": false + }, + "onKeyDown": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyDownCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPress": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPressCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUp": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUpCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onLayoutAnimationComplete": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component completes." + }, + "onLayoutAnimationStart": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component starts." + }, + "onLayoutMeasure": { + "type": "(box: Box, prevBox: Box) => void", + "required": false + }, + "onLoad": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedData": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedDataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadata": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStart": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStartCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLostPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onLostPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onMeasureDragConstraints": { + "type": "(constraints: BoundingBox) => void | BoundingBox", + "required": false, + "description": "If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints." + }, + "onMouseDown": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseDownCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseEnter": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseLeave": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMove": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMoveCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOut": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOutCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOver": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOverCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUp": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUpCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onPan": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture is recognised on this element.\n\n**Note:** For pan gestures to work correctly with touch input, the element needs\ntouch scrolling to be disabled on either x/y or both axis with the\n[touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) CSS rule.\n\n```jsx\nfunction onPan(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanEnd": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture ends on this element.\n\n```jsx\nfunction onPanEnd(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanSessionStart": { + "type": "(event: PointerEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when we begin detecting a pan gesture. This\nis analogous to `onMouseStart` or `onTouchStart`.\n\n```jsx\nfunction onPanSessionStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanStart": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture begins on this element.\n\n```jsx\nfunction onPanStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPaste": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPasteCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPause": { + "type": "ReactEventHandler", + "required": false + }, + "onPauseCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlaying": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPointerCancel": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerCancelCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDown": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDownCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnter": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnterCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeave": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeaveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMove": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMoveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOut": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOutCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOver": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOverCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUp": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUpCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onProgress": { + "type": "ReactEventHandler", + "required": false + }, + "onProgressCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChange": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onReset": { + "type": "FormEventHandler", + "required": false + }, + "onResetCapture": { + "type": "FormEventHandler", + "required": false + }, + "onResize": { + "type": "ReactEventHandler", + "required": false + }, + "onResizeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onScroll": { "type": "UIEventHandler", "required": false }, + "onScrollCapture": { + "type": "UIEventHandler", + "required": false + }, + "onSeeked": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSeeking": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSelect": { + "type": "ReactEventHandler", + "required": false + }, + "onSelectCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onStalled": { + "type": "ReactEventHandler", + "required": false + }, + "onStalledCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSubmit": { + "type": "FormEventHandler", + "required": false + }, + "onSubmitCapture": { + "type": "FormEventHandler", + "required": false + }, + "onSuspend": { + "type": "ReactEventHandler", + "required": false + }, + "onSuspendCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTap": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture successfully ends on this element.\n\n```jsx\nfunction onTap(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapCancel": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture ends outside this element.\n\n```jsx\nfunction onTapCancel(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture starts on this element.\n\n```jsx\nfunction onTapStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTimeUpdate": { + "type": "ReactEventHandler", + "required": false + }, + "onTimeUpdateCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTouchCancel": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchCancelCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEnd": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEndCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMove": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMoveCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStart": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStartCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTransitionEnd": { + "type": "TransitionEventHandler", + "required": false + }, + "onTransitionEndCapture": { + "type": "TransitionEventHandler", + "required": false + }, + "onUpdate": { + "type": "(latest: ResolvedValues) => void", + "required": false, + "description": "Callback with latest motion values, fired max once per frame.\n\n```jsx\nfunction onUpdate(latest) {\n console.log(latest.x, latest.opacity)\n}\n\n\n```" + }, + "onViewportEnter": { "type": "ViewportEventHandler", "required": false }, + "onViewportLeave": { "type": "ViewportEventHandler", "required": false }, + "onVolumeChange": { + "type": "ReactEventHandler", + "required": false + }, + "onVolumeChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWaiting": { + "type": "ReactEventHandler", + "required": false + }, + "onWaitingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWheel": { + "type": "WheelEventHandler", + "required": false + }, + "onWheelCapture": { + "type": "WheelEventHandler", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "prefix": { "type": "string", "required": false }, + "property": { "type": "string", "required": false }, + "radioGroup": { "type": "string", "required": false }, + "rel": { "type": "string", "required": false }, + "resource": { "type": "string", "required": false }, + "results": { "type": "number", "required": false }, + "rev": { "type": "string", "required": false }, + "role": { "type": "AriaRole", "required": false }, + "security": { "type": "string", "required": false }, + "slot": { "type": "string", "required": false }, + "spellCheck": { "type": "Booleanish", "required": false }, + "status": { + "type": "\"info\" | \"warning\" | \"success\" | \"error\"", + "required": false, + "description": "The status of the banner." + }, + "style": { + "type": "MotionStyle", + "required": false, + "description": "\nThe React DOM `style` prop, enhanced with support for `MotionValue`s and separate `transform` values.\n\n```jsx\nexport const MyComponent = () => {\n const x = useMotionValue(0)\n\n return \n}\n```" + }, + "suppressContentEditableWarning": { "type": "boolean", "required": false }, + "suppressHydrationWarning": { "type": "boolean", "required": false }, + "tabIndex": { "type": "number", "required": false }, + "title": { + "type": "string", + "defaultValue": ":selections selected", + "required": false, + "description": "The title\n\n\":selections\" will be replaced with the amount of selected items." + }, + "transformTemplate": { + "type": "(\n transform: TransformProperties,\n generatedTransform: string\n) => string", + "required": false, + "description": "By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate`\ncan be used to create a different order, or to append/preprend the automatically generated `transform` property.\n\n```jsx\n `rotate(${rotate}deg) translateX(${x}px)`\n }\n/>\n```" + }, + "transformValues": { + "type": "(values: V) => V", + "required": false, + "description": "Internal.\n\nThis allows values to be transformed before being animated or set as styles.\n\nFor instance, this allows custom values in Framer Library like `size` to be converted into `width` and `height`.\nIt also allows us a chance to take a value like `Color` and convert it to an animatable color string.\n\nA few structural typing changes need making before this can be a public property:\n- Allow `Target` values to be appended by user-defined types (delete `CustomStyles` - does `size` throw a type error?)\n- Extract `CustomValueType` as a separate user-defined type (delete `CustomValueType` and animate a `Color` - does this throw a type error?)." + }, + "translate": { "type": "\"yes\" | \"no\"", "required": false }, + "typeof": { "type": "string", "required": false }, + "unselectable": { "type": "\"on\" | \"off\"", "required": false }, + "variants": { + "type": "Variants", + "required": false, + "description": "Variants allow you to define animation states and organise them by name. They allow\nyou to control animations throughout a component tree by switching a single `animate` prop.\n\nUsing `transition` options like `delayChildren` and `staggerChildren`, you can orchestrate\nwhen children animations play relative to their parent.\n\n\nAfter passing variants to one or more `motion` component's `variants` prop, these variants\ncan be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n\n```jsx\nconst variants = {\n active: {\n backgroundColor: \"#f00\"\n },\n inactive: {\n backgroundColor: \"#fff\",\n transition: { duration: 2 }\n }\n}\n\n\n```" + }, + "viewport": { "type": "ViewportOptions", "required": false }, + "vocab": { "type": "string", "required": false }, + "whileDrag": { + "type": "VariantLabels | TargetAndTransition", + "required": false, + "description": "Properties or variant label to animate to while the drag gesture is recognised.\n\n```jsx\n\n```" + }, + "whileFocus": { + "type": "VariantLabels | TargetAndTransition", + "required": false, + "description": "Properties or variant label to animate to while the focus gesture is recognised.\n\n```jsx\n\n```" + }, + "whileHover": { + "type": "VariantLabels | TargetAndTransition", + "required": false, + "description": "Properties or variant label to animate to while the hover gesture is recognised.\n\n```jsx\n\n```" + }, + "whileInView": { + "type": "VariantLabels | TargetAndTransition", + "required": false + }, + "whileTap": { + "type": "VariantLabels | TargetAndTransition", + "required": false, + "description": "Properties or variant label to animate to while the component is pressed.\n\n```jsx\n\n```" + } + } +} diff --git a/tooling/props-docs/dist/components/CalendarIcon.json b/tooling/props-docs/dist/components/CalendarIcon.json new file mode 100644 index 000000000..2e1e016fc --- /dev/null +++ b/tooling/props-docs/dist/components/CalendarIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"CalendarIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Charts.json b/tooling/props-docs/dist/components/Charts.json new file mode 100644 index 000000000..0ba25f29c --- /dev/null +++ b/tooling/props-docs/dist/components/Charts.json @@ -0,0 +1,540 @@ +{ + "Sparkline": { + "data": { + "type": "Record[]", + "required": true, + "description": "The chart data." + }, + "animationDuration": { + "type": "number", + "defaultValue": "500", + "required": false, + "description": "The animation duration." + }, + "categories": { + "type": "string[]", + "defaultValue": "['value']", + "required": false, + "description": "The categories to display, values map to keys in data." + }, + "colors": { + "type": "string[]", + "defaultValue": "['primary', 'gray']", + "required": false, + "description": "Colors to use for each category." + }, + "connectNulls": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Whether to connect null values." + }, + "curveType": { + "type": "CurveType", + "required": false, + "description": "The curve type of the area." + }, + "showAnimation": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to show animation." + }, + "stack": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to stack the categories." + }, + "strokeWidth": { + "type": "number", + "required": false, + "description": "The width of the line." + }, + "variant": { + "type": "\"line\" | \"solid\" | \"gradient\"", + "defaultValue": "gradient", + "required": false, + "description": "The sparkline variant." + } + }, + "AreaChart": { + "data": { + "type": "Record[]", + "required": true, + "description": "The data to be displayed in the chart." + }, + "allowDecimals": { + "type": "boolean", + "required": false, + "description": "Show decimals on the y-axis." + }, + "animationDuration": { + "type": "number", + "required": false, + "description": "Animation duration in milliseconds." + }, + "categories": { + "type": "string[]", + "required": false, + "description": "The data keys to be displayed in the chart." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children to render." + }, + "colors": { + "type": "string[]", + "required": false, + "description": "The colors to use for each category." + }, + "connectNulls": { + "type": "boolean", + "required": false, + "description": "Whether to connect null values." + }, + "curveType": { + "type": "CurveType", + "required": false, + "description": "The curve type of the area." + }, + "height": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"-moz-max-content\"\n | \"-moz-min-content\"\n | \"-webkit-fit-content\"\n | \"auto\"\n | \"fit-content\"\n | \"max-content\"\n | \"min-content\"\n>", + "required": false, + "description": "The height of the chart." + }, + "index": { + "type": "string", + "defaultValue": "'date'", + "required": false, + "description": "The y-axis data key to use." + }, + "intervalType": { + "type": "type ONLY_FOR_FORMAT =\n | number\n | \"preserveStartEnd\"\n | \"equidistantPreserveStart\"\n | \"preserveStart\"\n | \"preserveEnd\"", + "required": false, + "description": "If set 0, all the ticks will be shown. If set preserveStart\", \"preserveEnd\" or \"preserveStartEnd\", the ticks which is to be shown or hidden will be calculated automatically." + }, + "legendHeight": { + "type": "number", + "required": false, + "description": "Height of the legend." + }, + "showAnimation": { + "type": "boolean", + "required": false, + "description": "Wether to show the animation or not." + }, + "showGrid": { + "type": "boolean", + "required": false, + "description": "Wether to show the grid or not." + }, + "showLegend": { + "type": "boolean", + "required": false, + "description": "Wether to show the legend or not." + }, + "showTooltip": { + "type": "boolean", + "required": false, + "description": "Wether to show the tooltip or not." + }, + "showXAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the x-axis or not." + }, + "showYAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the y-axis or not." + }, + "stack": { + "type": "boolean", + "required": false, + "description": "Whether to stack the areas." + }, + "startEndOnly": { + "type": "boolean", + "required": false, + "description": "Only show the start and end ticks on the x-axis." + }, + "strokeWidth": { + "type": "string | number", + "required": false, + "description": "The width of the line." + }, + "tooltipContent": { + "type": "(props: TooltipProps) => ReactNode", + "required": false, + "description": "Render custom tooltip content." + }, + "valueFormatter": { + "type": "(value: number) => string", + "required": false, + "description": "Format the value of the x-axis." + }, + "variant": { + "type": "\"line\" | \"solid\" | \"gradient\"", + "defaultValue": "gradient", + "required": false, + "description": "The area chart variant." + }, + "yAxisWidth": { + "type": "number", + "required": false, + "description": "Width of the y-axis labels." + } + }, + "LineChart": { + "data": { + "type": "Record[]", + "required": true, + "description": "The data to be displayed in the chart." + }, + "allowDecimals": { + "type": "boolean", + "required": false, + "description": "Show decimals on the y-axis." + }, + "animationDuration": { + "type": "number", + "required": false, + "description": "Animation duration in milliseconds." + }, + "categories": { + "type": "string[]", + "required": false, + "description": "The data keys to be displayed in the chart." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children to render." + }, + "colors": { + "type": "string[]", + "required": false, + "description": "The colors to use for each category." + }, + "connectNulls": { + "type": "boolean", + "required": false, + "description": "Whether to connect null values." + }, + "curveType": { + "type": "CurveType", + "required": false, + "description": "The curve type of the line." + }, + "height": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"-moz-max-content\"\n | \"-moz-min-content\"\n | \"-webkit-fit-content\"\n | \"auto\"\n | \"fit-content\"\n | \"max-content\"\n | \"min-content\"\n>", + "required": false, + "description": "The height of the chart." + }, + "index": { + "type": "string", + "defaultValue": "'date'", + "required": false, + "description": "The y-axis data key to use." + }, + "intervalType": { + "type": "type ONLY_FOR_FORMAT =\n | number\n | \"preserveStartEnd\"\n | \"equidistantPreserveStart\"\n | \"preserveStart\"\n | \"preserveEnd\"", + "required": false, + "description": "If set 0, all the ticks will be shown. If set preserveStart\", \"preserveEnd\" or \"preserveStartEnd\", the ticks which is to be shown or hidden will be calculated automatically." + }, + "legendHeight": { + "type": "number", + "required": false, + "description": "Height of the legend." + }, + "showAnimation": { + "type": "boolean", + "required": false, + "description": "Wether to show the animation or not." + }, + "showGrid": { + "type": "boolean", + "required": false, + "description": "Wether to show the grid or not." + }, + "showLegend": { + "type": "boolean", + "required": false, + "description": "Wether to show the legend or not." + }, + "showTooltip": { + "type": "boolean", + "required": false, + "description": "Wether to show the tooltip or not." + }, + "showXAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the x-axis or not." + }, + "showYAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the y-axis or not." + }, + "startEndOnly": { + "type": "boolean", + "required": false, + "description": "Only show the start and end ticks on the x-axis." + }, + "strokeWidth": { + "type": "string | number", + "required": false, + "description": "The width of the line." + }, + "tooltipContent": { + "type": "(props: TooltipProps) => ReactNode", + "required": false, + "description": "Render custom tooltip content." + }, + "valueFormatter": { + "type": "(value: number) => string", + "required": false, + "description": "Format the value of the x-axis." + }, + "yAxisWidth": { + "type": "number", + "required": false, + "description": "Width of the y-axis labels." + } + }, + "BarChart": { + "data": { + "type": "Record[]", + "required": true, + "description": "The data to be displayed in the chart." + }, + "allowDecimals": { + "type": "boolean", + "required": false, + "description": "Show decimals on the y-axis." + }, + "animationDuration": { + "type": "number", + "required": false, + "description": "Animation duration in milliseconds." + }, + "barCategoryGap": { + "type": "string | number", + "required": false, + "description": "Gap between categories in pixels or percentage." + }, + "barGap": { + "type": "string | number", + "required": false, + "description": "Gap between bars in pixels or percentage." + }, + "categories": { + "type": "string[]", + "required": false, + "description": "The data keys to be displayed in the chart." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children to render." + }, + "colors": { + "type": "string[]", + "required": false, + "description": "The colors to use for each category." + }, + "height": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"-moz-max-content\"\n | \"-moz-min-content\"\n | \"-webkit-fit-content\"\n | \"auto\"\n | \"fit-content\"\n | \"max-content\"\n | \"min-content\"\n>", + "required": false, + "description": "The height of the chart." + }, + "index": { + "type": "string", + "defaultValue": "'date'", + "required": false, + "description": "The y-axis data key to use." + }, + "intervalType": { + "type": "type ONLY_FOR_FORMAT =\n | number\n | \"preserveStartEnd\"\n | \"equidistantPreserveStart\"\n | \"preserveStart\"\n | \"preserveEnd\"", + "required": false, + "description": "If set 0, all the ticks will be shown. If set preserveStart\", \"preserveEnd\" or \"preserveStartEnd\", the ticks which is to be shown or hidden will be calculated automatically." + }, + "legendHeight": { + "type": "number", + "required": false, + "description": "Height of the legend." + }, + "radius": { + "type": "number | [number, number, number, number]", + "required": false, + "description": "Radius of the bars." + }, + "showAnimation": { + "type": "boolean", + "required": false, + "description": "Wether to show the animation or not." + }, + "showGrid": { + "type": "boolean", + "required": false, + "description": "Wether to show the grid or not." + }, + "showLegend": { + "type": "boolean", + "required": false, + "description": "Wether to show the legend or not." + }, + "showTooltip": { + "type": "boolean", + "required": false, + "description": "Wether to show the tooltip or not." + }, + "showXAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the x-axis or not." + }, + "showYAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the y-axis or not." + }, + "stack": { + "type": "boolean", + "required": false, + "description": "Whether to stack the bars." + }, + "startEndOnly": { + "type": "boolean", + "required": false, + "description": "Only show the start and end ticks on the x-axis." + }, + "tooltipContent": { + "type": "(props: TooltipProps) => ReactNode", + "required": false, + "description": "Render custom tooltip content." + }, + "valueFormatter": { + "type": "(value: number) => string", + "required": false, + "description": "Format the value of the x-axis." + }, + "variant": { + "type": "\"solid\" | \"gradient\"", + "defaultValue": "gradient", + "required": false, + "description": "The bar chart variant." + }, + "yAxisWidth": { + "type": "number", + "required": false, + "description": "Width of the y-axis labels." + } + }, + "BaseChart": { + "data": { + "type": "Record[]", + "required": true, + "description": "The data to be displayed in the chart." + }, + "allowDecimals": { + "type": "boolean", + "required": false, + "description": "Show decimals on the y-axis." + }, + "animationDuration": { + "type": "number", + "required": false, + "description": "Animation duration in milliseconds." + }, + "categories": { + "type": "string[]", + "required": false, + "description": "The data keys to be displayed in the chart." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Children to render." + }, + "colors": { + "type": "string[]", + "required": false, + "description": "The colors to use for each category." + }, + "height": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"-moz-max-content\"\n | \"-moz-min-content\"\n | \"-webkit-fit-content\"\n | \"auto\"\n | \"fit-content\"\n | \"max-content\"\n | \"min-content\"\n>", + "required": false, + "description": "The height of the chart." + }, + "index": { + "type": "string", + "defaultValue": "'date'", + "required": false, + "description": "The y-axis data key to use." + }, + "intervalType": { + "type": "type ONLY_FOR_FORMAT =\n | number\n | \"preserveStartEnd\"\n | \"equidistantPreserveStart\"\n | \"preserveStart\"\n | \"preserveEnd\"", + "required": false, + "description": "If set 0, all the ticks will be shown. If set preserveStart\", \"preserveEnd\" or \"preserveStartEnd\", the ticks which is to be shown or hidden will be calculated automatically." + }, + "legendHeight": { + "type": "number", + "required": false, + "description": "Height of the legend." + }, + "showAnimation": { + "type": "boolean", + "required": false, + "description": "Wether to show the animation or not." + }, + "showGrid": { + "type": "boolean", + "required": false, + "description": "Wether to show the grid or not." + }, + "showLegend": { + "type": "boolean", + "required": false, + "description": "Wether to show the legend or not." + }, + "showTooltip": { + "type": "boolean", + "required": false, + "description": "Wether to show the tooltip or not." + }, + "showXAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the x-axis or not." + }, + "showYAxis": { + "type": "boolean", + "required": false, + "description": "Wether to show the y-axis or not." + }, + "startEndOnly": { + "type": "boolean", + "required": false, + "description": "Only show the start and end ticks on the x-axis." + }, + "tooltipContent": { + "type": "(props: TooltipProps) => ReactNode", + "required": false, + "description": "Render custom tooltip content." + }, + "valueFormatter": { + "type": "(value: number) => string", + "required": false, + "description": "Format the value of the x-axis." + }, + "yAxisWidth": { + "type": "number", + "required": false, + "description": "Width of the y-axis labels." + } + } +} diff --git a/tooling/props-docs/dist/components/CheckIcon.json b/tooling/props-docs/dist/components/CheckIcon.json new file mode 100644 index 000000000..98f1f95fe --- /dev/null +++ b/tooling/props-docs/dist/components/CheckIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"CheckIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/CheckboxField.json b/tooling/props-docs/dist/components/CheckboxField.json new file mode 100644 index 000000000..c7c80d0c5 --- /dev/null +++ b/tooling/props-docs/dist/components/CheckboxField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"CheckboxField","methods":[],"props":{"spacing":{"defaultValue":{"value":"0.5rem"},"description":"The spacing between the checkbox and its label text","name":"spacing","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemProps[\"marginLeft\"]"}},"iconColor":{"defaultValue":null,"description":"The color of the checkbox icon when checked or indeterminate","name":"iconColor","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"iconSize":{"defaultValue":null,"description":"The size of the checkbox icon when checked or indeterminate","name":"iconSize","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string | number"}},"icon":{"defaultValue":{"value":"CheckboxIcon"},"description":"The checked icon to use","name":"icon","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"React.ReactElement"}},"inputProps":{"defaultValue":null,"description":"Additional props to be forwarded to the `input` element","name":"inputProps","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"InputHTMLAttributes"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ChevronDownIcon.json b/tooling/props-docs/dist/components/ChevronDownIcon.json new file mode 100644 index 000000000..aa180a31b --- /dev/null +++ b/tooling/props-docs/dist/components/ChevronDownIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ChevronDownIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ChevronLeftIcon.json b/tooling/props-docs/dist/components/ChevronLeftIcon.json new file mode 100644 index 000000000..15f21b0f6 --- /dev/null +++ b/tooling/props-docs/dist/components/ChevronLeftIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ChevronLeftIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ChevronRightIcon.json b/tooling/props-docs/dist/components/ChevronRightIcon.json new file mode 100644 index 000000000..4fe0d5fdc --- /dev/null +++ b/tooling/props-docs/dist/components/ChevronRightIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ChevronRightIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ChevronUpIcon.json b/tooling/props-docs/dist/components/ChevronUpIcon.json new file mode 100644 index 000000000..50eb9930c --- /dev/null +++ b/tooling/props-docs/dist/components/ChevronUpIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ChevronUpIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ClerkAuthProvider.json b/tooling/props-docs/dist/components/ClerkAuthProvider.json new file mode 100644 index 000000000..fa9818310 --- /dev/null +++ b/tooling/props-docs/dist/components/ClerkAuthProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-clerk/src/index.ts","description":"","displayName":"ClerkAuthProvider","methods":[],"props":{"isSatellite":{"defaultValue":null,"description":"","name":"isSatellite","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean | ((url: URL) => boolean)"}},"Clerk":{"defaultValue":null,"description":"","name":"Clerk","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/clerk-react/dist/types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"ClerkProp"}},"clerkJSUrl":{"defaultValue":null,"description":"","name":"clerkJSUrl","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/clerk-react/dist/types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"clerkJSVariant":{"defaultValue":null,"description":"","name":"clerkJSVariant","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/clerk-react/dist/types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"\" | \"headless\""}},"proxyUrl":{"defaultValue":null,"description":"","name":"proxyUrl","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"domain":{"defaultValue":null,"description":"","name":"domain","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/multiDomain.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"DOMAIN"}},"frontendApi":{"defaultValue":null,"description":"","name":"frontendApi","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/key.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/key.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"publishableKey":{"defaultValue":null,"description":"","name":"publishableKey","declarations":[{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/key.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-clerk/node_modules/@clerk/types/dist/key.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/CloseIcon.json b/tooling/props-docs/dist/components/CloseIcon.json new file mode 100644 index 000000000..e9dfd1ff1 --- /dev/null +++ b/tooling/props-docs/dist/components/CloseIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"CloseIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Collapse.json b/tooling/props-docs/dist/components/Collapse.json new file mode 100644 index 000000000..4a3e2d17e --- /dev/null +++ b/tooling/props-docs/dist/components/Collapse.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"Collapse","methods":[],"props":{"slot":{"defaultValue":null,"description":"","name":"slot","required":false,"type":{"name":"string"}},"title":{"defaultValue":null,"description":"","name":"title","required":false,"type":{"name":"string"}},"defaultChecked":{"defaultValue":null,"description":"","name":"defaultChecked","required":false,"type":{"name":"boolean"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","required":false,"type":{"name":"string | number | readonly string[]"}},"suppressContentEditableWarning":{"defaultValue":null,"description":"","name":"suppressContentEditableWarning","required":false,"type":{"name":"boolean"}},"suppressHydrationWarning":{"defaultValue":null,"description":"","name":"suppressHydrationWarning","required":false,"type":{"name":"boolean"}},"accessKey":{"defaultValue":null,"description":"","name":"accessKey","required":false,"type":{"name":"string"}},"autoFocus":{"defaultValue":null,"description":"","name":"autoFocus","required":false,"type":{"name":"boolean"}},"className":{"defaultValue":null,"description":"","name":"className","required":false,"type":{"name":"string"}},"contentEditable":{"defaultValue":null,"description":"","name":"contentEditable","required":false,"type":{"name":"\"inherit\" | Booleanish"}},"contextMenu":{"defaultValue":null,"description":"","name":"contextMenu","required":false,"type":{"name":"string"}},"dir":{"defaultValue":null,"description":"","name":"dir","required":false,"type":{"name":"string"}},"draggable":{"defaultValue":null,"description":"","name":"draggable","required":false,"type":{"name":"Booleanish"}},"hidden":{"defaultValue":null,"description":"","name":"hidden","required":false,"type":{"name":"boolean"}},"id":{"defaultValue":null,"description":"","name":"id","required":false,"type":{"name":"string"}},"lang":{"defaultValue":null,"description":"","name":"lang","required":false,"type":{"name":"string"}},"nonce":{"defaultValue":null,"description":"","name":"nonce","required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"","name":"placeholder","required":false,"type":{"name":"string"}},"spellCheck":{"defaultValue":null,"description":"","name":"spellCheck","required":false,"type":{"name":"Booleanish"}},"tabIndex":{"defaultValue":null,"description":"","name":"tabIndex","required":false,"type":{"name":"number"}},"translate":{"defaultValue":null,"description":"","name":"translate","required":false,"type":{"name":"\"yes\" | \"no\""}},"radioGroup":{"defaultValue":null,"description":"","name":"radioGroup","required":false,"type":{"name":"string"}},"role":{"defaultValue":null,"description":"","name":"role","required":false,"type":{"name":"AriaRole"}},"about":{"defaultValue":null,"description":"","name":"about","required":false,"type":{"name":"string"}},"content":{"defaultValue":null,"description":"","name":"content","required":false,"type":{"name":"string"}},"datatype":{"defaultValue":null,"description":"","name":"datatype","required":false,"type":{"name":"string"}},"inlist":{"defaultValue":null,"description":"","name":"inlist","required":false,"type":{"name":"any"}},"prefix":{"defaultValue":null,"description":"","name":"prefix","required":false,"type":{"name":"string"}},"property":{"defaultValue":null,"description":"","name":"property","required":false,"type":{"name":"string"}},"rel":{"defaultValue":null,"description":"","name":"rel","required":false,"type":{"name":"string"}},"resource":{"defaultValue":null,"description":"","name":"resource","required":false,"type":{"name":"string"}},"rev":{"defaultValue":null,"description":"","name":"rev","required":false,"type":{"name":"string"}},"typeof":{"defaultValue":null,"description":"","name":"typeof","required":false,"type":{"name":"string"}},"vocab":{"defaultValue":null,"description":"","name":"vocab","required":false,"type":{"name":"string"}},"autoCapitalize":{"defaultValue":null,"description":"","name":"autoCapitalize","required":false,"type":{"name":"string"}},"autoCorrect":{"defaultValue":null,"description":"","name":"autoCorrect","required":false,"type":{"name":"string"}},"autoSave":{"defaultValue":null,"description":"","name":"autoSave","required":false,"type":{"name":"string"}},"itemProp":{"defaultValue":null,"description":"","name":"itemProp","required":false,"type":{"name":"string"}},"itemScope":{"defaultValue":null,"description":"","name":"itemScope","required":false,"type":{"name":"boolean"}},"itemType":{"defaultValue":null,"description":"","name":"itemType","required":false,"type":{"name":"string"}},"itemID":{"defaultValue":null,"description":"","name":"itemID","required":false,"type":{"name":"string"}},"itemRef":{"defaultValue":null,"description":"","name":"itemRef","required":false,"type":{"name":"string"}},"results":{"defaultValue":null,"description":"","name":"results","required":false,"type":{"name":"number"}},"security":{"defaultValue":null,"description":"","name":"security","required":false,"type":{"name":"string"}},"unselectable":{"defaultValue":null,"description":"","name":"unselectable","required":false,"type":{"name":"\"on\" | \"off\""}},"inputMode":{"defaultValue":null,"description":"","name":"inputMode","required":false,"type":{"name":"\"none\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\""}},"is":{"defaultValue":null,"description":"","name":"is","required":false,"type":{"name":"string"}},"dangerouslySetInnerHTML":{"defaultValue":null,"description":"","name":"dangerouslySetInnerHTML","required":false,"type":{"name":"{ __html: string | TrustedHTML; }"}},"onCopy":{"defaultValue":null,"description":"","name":"onCopy","required":false,"type":{"name":"ClipboardEventHandler"}},"onCopyCapture":{"defaultValue":null,"description":"","name":"onCopyCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onCut":{"defaultValue":null,"description":"","name":"onCut","required":false,"type":{"name":"ClipboardEventHandler"}},"onCutCapture":{"defaultValue":null,"description":"","name":"onCutCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onPaste":{"defaultValue":null,"description":"","name":"onPaste","required":false,"type":{"name":"ClipboardEventHandler"}},"onPasteCapture":{"defaultValue":null,"description":"","name":"onPasteCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onCompositionEnd":{"defaultValue":null,"description":"","name":"onCompositionEnd","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionEndCapture":{"defaultValue":null,"description":"","name":"onCompositionEndCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStart":{"defaultValue":null,"description":"","name":"onCompositionStart","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStartCapture":{"defaultValue":null,"description":"","name":"onCompositionStartCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdate":{"defaultValue":null,"description":"","name":"onCompositionUpdate","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdateCapture":{"defaultValue":null,"description":"","name":"onCompositionUpdateCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onFocus":{"defaultValue":null,"description":"","name":"onFocus","required":false,"type":{"name":"FocusEventHandler"}},"onFocusCapture":{"defaultValue":null,"description":"","name":"onFocusCapture","required":false,"type":{"name":"FocusEventHandler"}},"onBlur":{"defaultValue":null,"description":"","name":"onBlur","required":false,"type":{"name":"FocusEventHandler"}},"onBlurCapture":{"defaultValue":null,"description":"","name":"onBlurCapture","required":false,"type":{"name":"FocusEventHandler"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","required":false,"type":{"name":"FormEventHandler"}},"onChangeCapture":{"defaultValue":null,"description":"","name":"onChangeCapture","required":false,"type":{"name":"FormEventHandler"}},"onBeforeInput":{"defaultValue":null,"description":"","name":"onBeforeInput","required":false,"type":{"name":"FormEventHandler"}},"onBeforeInputCapture":{"defaultValue":null,"description":"","name":"onBeforeInputCapture","required":false,"type":{"name":"FormEventHandler"}},"onInput":{"defaultValue":null,"description":"","name":"onInput","required":false,"type":{"name":"FormEventHandler"}},"onInputCapture":{"defaultValue":null,"description":"","name":"onInputCapture","required":false,"type":{"name":"FormEventHandler"}},"onReset":{"defaultValue":null,"description":"","name":"onReset","required":false,"type":{"name":"FormEventHandler"}},"onResetCapture":{"defaultValue":null,"description":"","name":"onResetCapture","required":false,"type":{"name":"FormEventHandler"}},"onSubmit":{"defaultValue":null,"description":"","name":"onSubmit","required":false,"type":{"name":"FormEventHandler"}},"onSubmitCapture":{"defaultValue":null,"description":"","name":"onSubmitCapture","required":false,"type":{"name":"FormEventHandler"}},"onInvalid":{"defaultValue":null,"description":"","name":"onInvalid","required":false,"type":{"name":"FormEventHandler"}},"onInvalidCapture":{"defaultValue":null,"description":"","name":"onInvalidCapture","required":false,"type":{"name":"FormEventHandler"}},"onLoad":{"defaultValue":null,"description":"","name":"onLoad","required":false,"type":{"name":"ReactEventHandler"}},"onLoadCapture":{"defaultValue":null,"description":"","name":"onLoadCapture","required":false,"type":{"name":"ReactEventHandler"}},"onError":{"defaultValue":null,"description":"","name":"onError","required":false,"type":{"name":"ReactEventHandler"}},"onErrorCapture":{"defaultValue":null,"description":"","name":"onErrorCapture","required":false,"type":{"name":"ReactEventHandler"}},"onKeyDown":{"defaultValue":null,"description":"","name":"onKeyDown","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyDownCapture":{"defaultValue":null,"description":"","name":"onKeyDownCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPress":{"defaultValue":null,"description":"","name":"onKeyPress","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPressCapture":{"defaultValue":null,"description":"","name":"onKeyPressCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUp":{"defaultValue":null,"description":"","name":"onKeyUp","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUpCapture":{"defaultValue":null,"description":"","name":"onKeyUpCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onAbort":{"defaultValue":null,"description":"","name":"onAbort","required":false,"type":{"name":"ReactEventHandler"}},"onAbortCapture":{"defaultValue":null,"description":"","name":"onAbortCapture","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlay":{"defaultValue":null,"description":"","name":"onCanPlay","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayCapture":{"defaultValue":null,"description":"","name":"onCanPlayCapture","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThrough":{"defaultValue":null,"description":"","name":"onCanPlayThrough","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThroughCapture":{"defaultValue":null,"description":"","name":"onCanPlayThroughCapture","required":false,"type":{"name":"ReactEventHandler"}},"onDurationChange":{"defaultValue":null,"description":"","name":"onDurationChange","required":false,"type":{"name":"ReactEventHandler"}},"onDurationChangeCapture":{"defaultValue":null,"description":"","name":"onDurationChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEmptied":{"defaultValue":null,"description":"","name":"onEmptied","required":false,"type":{"name":"ReactEventHandler"}},"onEmptiedCapture":{"defaultValue":null,"description":"","name":"onEmptiedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEncrypted":{"defaultValue":null,"description":"","name":"onEncrypted","required":false,"type":{"name":"ReactEventHandler"}},"onEncryptedCapture":{"defaultValue":null,"description":"","name":"onEncryptedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEnded":{"defaultValue":null,"description":"","name":"onEnded","required":false,"type":{"name":"ReactEventHandler"}},"onEndedCapture":{"defaultValue":null,"description":"","name":"onEndedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedData":{"defaultValue":null,"description":"","name":"onLoadedData","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedDataCapture":{"defaultValue":null,"description":"","name":"onLoadedDataCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadata":{"defaultValue":null,"description":"","name":"onLoadedMetadata","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadataCapture":{"defaultValue":null,"description":"","name":"onLoadedMetadataCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadStart":{"defaultValue":null,"description":"","name":"onLoadStart","required":false,"type":{"name":"ReactEventHandler"}},"onLoadStartCapture":{"defaultValue":null,"description":"","name":"onLoadStartCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPause":{"defaultValue":null,"description":"","name":"onPause","required":false,"type":{"name":"ReactEventHandler"}},"onPauseCapture":{"defaultValue":null,"description":"","name":"onPauseCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPlay":{"defaultValue":null,"description":"","name":"onPlay","required":false,"type":{"name":"ReactEventHandler"}},"onPlayCapture":{"defaultValue":null,"description":"","name":"onPlayCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPlaying":{"defaultValue":null,"description":"","name":"onPlaying","required":false,"type":{"name":"ReactEventHandler"}},"onPlayingCapture":{"defaultValue":null,"description":"","name":"onPlayingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onProgress":{"defaultValue":null,"description":"","name":"onProgress","required":false,"type":{"name":"ReactEventHandler"}},"onProgressCapture":{"defaultValue":null,"description":"","name":"onProgressCapture","required":false,"type":{"name":"ReactEventHandler"}},"onRateChange":{"defaultValue":null,"description":"","name":"onRateChange","required":false,"type":{"name":"ReactEventHandler"}},"onRateChangeCapture":{"defaultValue":null,"description":"","name":"onRateChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onResize":{"defaultValue":null,"description":"","name":"onResize","required":false,"type":{"name":"ReactEventHandler"}},"onResizeCapture":{"defaultValue":null,"description":"","name":"onResizeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSeeked":{"defaultValue":null,"description":"","name":"onSeeked","required":false,"type":{"name":"ReactEventHandler"}},"onSeekedCapture":{"defaultValue":null,"description":"","name":"onSeekedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSeeking":{"defaultValue":null,"description":"","name":"onSeeking","required":false,"type":{"name":"ReactEventHandler"}},"onSeekingCapture":{"defaultValue":null,"description":"","name":"onSeekingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onStalled":{"defaultValue":null,"description":"","name":"onStalled","required":false,"type":{"name":"ReactEventHandler"}},"onStalledCapture":{"defaultValue":null,"description":"","name":"onStalledCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSuspend":{"defaultValue":null,"description":"","name":"onSuspend","required":false,"type":{"name":"ReactEventHandler"}},"onSuspendCapture":{"defaultValue":null,"description":"","name":"onSuspendCapture","required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdate":{"defaultValue":null,"description":"","name":"onTimeUpdate","required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdateCapture":{"defaultValue":null,"description":"","name":"onTimeUpdateCapture","required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChange":{"defaultValue":null,"description":"","name":"onVolumeChange","required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChangeCapture":{"defaultValue":null,"description":"","name":"onVolumeChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onWaiting":{"defaultValue":null,"description":"","name":"onWaiting","required":false,"type":{"name":"ReactEventHandler"}},"onWaitingCapture":{"defaultValue":null,"description":"","name":"onWaitingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onAuxClick":{"defaultValue":null,"description":"","name":"onAuxClick","required":false,"type":{"name":"MouseEventHandler"}},"onAuxClickCapture":{"defaultValue":null,"description":"","name":"onAuxClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onClick":{"defaultValue":null,"description":"","name":"onClick","required":false,"type":{"name":"MouseEventHandler"}},"onClickCapture":{"defaultValue":null,"description":"","name":"onClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onContextMenu":{"defaultValue":null,"description":"","name":"onContextMenu","required":false,"type":{"name":"MouseEventHandler"}},"onContextMenuCapture":{"defaultValue":null,"description":"","name":"onContextMenuCapture","required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClick":{"defaultValue":null,"description":"","name":"onDoubleClick","required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClickCapture":{"defaultValue":null,"description":"","name":"onDoubleClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onDragCapture":{"defaultValue":null,"description":"","name":"onDragCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragEndCapture":{"defaultValue":null,"description":"","name":"onDragEndCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragEnter":{"defaultValue":null,"description":"","name":"onDragEnter","required":false,"type":{"name":"DragEventHandler"}},"onDragEnterCapture":{"defaultValue":null,"description":"","name":"onDragEnterCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragExit":{"defaultValue":null,"description":"","name":"onDragExit","required":false,"type":{"name":"DragEventHandler"}},"onDragExitCapture":{"defaultValue":null,"description":"","name":"onDragExitCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragLeave":{"defaultValue":null,"description":"","name":"onDragLeave","required":false,"type":{"name":"DragEventHandler"}},"onDragLeaveCapture":{"defaultValue":null,"description":"","name":"onDragLeaveCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragOver":{"defaultValue":null,"description":"","name":"onDragOver","required":false,"type":{"name":"DragEventHandler"}},"onDragOverCapture":{"defaultValue":null,"description":"","name":"onDragOverCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragStartCapture":{"defaultValue":null,"description":"","name":"onDragStartCapture","required":false,"type":{"name":"DragEventHandler"}},"onDrop":{"defaultValue":null,"description":"","name":"onDrop","required":false,"type":{"name":"DragEventHandler"}},"onDropCapture":{"defaultValue":null,"description":"","name":"onDropCapture","required":false,"type":{"name":"DragEventHandler"}},"onMouseDown":{"defaultValue":null,"description":"","name":"onMouseDown","required":false,"type":{"name":"MouseEventHandler"}},"onMouseDownCapture":{"defaultValue":null,"description":"","name":"onMouseDownCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseEnter":{"defaultValue":null,"description":"","name":"onMouseEnter","required":false,"type":{"name":"MouseEventHandler"}},"onMouseLeave":{"defaultValue":null,"description":"","name":"onMouseLeave","required":false,"type":{"name":"MouseEventHandler"}},"onMouseMove":{"defaultValue":null,"description":"","name":"onMouseMove","required":false,"type":{"name":"MouseEventHandler"}},"onMouseMoveCapture":{"defaultValue":null,"description":"","name":"onMouseMoveCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOut":{"defaultValue":null,"description":"","name":"onMouseOut","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOutCapture":{"defaultValue":null,"description":"","name":"onMouseOutCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOver":{"defaultValue":null,"description":"","name":"onMouseOver","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOverCapture":{"defaultValue":null,"description":"","name":"onMouseOverCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseUp":{"defaultValue":null,"description":"","name":"onMouseUp","required":false,"type":{"name":"MouseEventHandler"}},"onMouseUpCapture":{"defaultValue":null,"description":"","name":"onMouseUpCapture","required":false,"type":{"name":"MouseEventHandler"}},"onSelect":{"defaultValue":null,"description":"","name":"onSelect","required":false,"type":{"name":"ReactEventHandler"}},"onSelectCapture":{"defaultValue":null,"description":"","name":"onSelectCapture","required":false,"type":{"name":"ReactEventHandler"}},"onTouchCancel":{"defaultValue":null,"description":"","name":"onTouchCancel","required":false,"type":{"name":"TouchEventHandler"}},"onTouchCancelCapture":{"defaultValue":null,"description":"","name":"onTouchCancelCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchEnd":{"defaultValue":null,"description":"","name":"onTouchEnd","required":false,"type":{"name":"TouchEventHandler"}},"onTouchEndCapture":{"defaultValue":null,"description":"","name":"onTouchEndCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchMove":{"defaultValue":null,"description":"","name":"onTouchMove","required":false,"type":{"name":"TouchEventHandler"}},"onTouchMoveCapture":{"defaultValue":null,"description":"","name":"onTouchMoveCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchStart":{"defaultValue":null,"description":"","name":"onTouchStart","required":false,"type":{"name":"TouchEventHandler"}},"onTouchStartCapture":{"defaultValue":null,"description":"","name":"onTouchStartCapture","required":false,"type":{"name":"TouchEventHandler"}},"onPointerDown":{"defaultValue":null,"description":"","name":"onPointerDown","required":false,"type":{"name":"PointerEventHandler"}},"onPointerDownCapture":{"defaultValue":null,"description":"","name":"onPointerDownCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerMove":{"defaultValue":null,"description":"","name":"onPointerMove","required":false,"type":{"name":"PointerEventHandler"}},"onPointerMoveCapture":{"defaultValue":null,"description":"","name":"onPointerMoveCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerUp":{"defaultValue":null,"description":"","name":"onPointerUp","required":false,"type":{"name":"PointerEventHandler"}},"onPointerUpCapture":{"defaultValue":null,"description":"","name":"onPointerUpCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancel":{"defaultValue":null,"description":"","name":"onPointerCancel","required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancelCapture":{"defaultValue":null,"description":"","name":"onPointerCancelCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnter":{"defaultValue":null,"description":"","name":"onPointerEnter","required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnterCapture":{"defaultValue":null,"description":"","name":"onPointerEnterCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeave":{"defaultValue":null,"description":"","name":"onPointerLeave","required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeaveCapture":{"defaultValue":null,"description":"","name":"onPointerLeaveCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOver":{"defaultValue":null,"description":"","name":"onPointerOver","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOverCapture":{"defaultValue":null,"description":"","name":"onPointerOverCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOut":{"defaultValue":null,"description":"","name":"onPointerOut","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOutCapture":{"defaultValue":null,"description":"","name":"onPointerOutCapture","required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCapture":{"defaultValue":null,"description":"","name":"onGotPointerCapture","required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onGotPointerCaptureCapture","required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCapture":{"defaultValue":null,"description":"","name":"onLostPointerCapture","required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onLostPointerCaptureCapture","required":false,"type":{"name":"PointerEventHandler"}},"onScroll":{"defaultValue":null,"description":"","name":"onScroll","required":false,"type":{"name":"UIEventHandler"}},"onScrollCapture":{"defaultValue":null,"description":"","name":"onScrollCapture","required":false,"type":{"name":"UIEventHandler"}},"onWheel":{"defaultValue":null,"description":"","name":"onWheel","required":false,"type":{"name":"WheelEventHandler"}},"onWheelCapture":{"defaultValue":null,"description":"","name":"onWheelCapture","required":false,"type":{"name":"WheelEventHandler"}},"onAnimationStartCapture":{"defaultValue":null,"description":"","name":"onAnimationStartCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEnd":{"defaultValue":null,"description":"","name":"onAnimationEnd","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEndCapture":{"defaultValue":null,"description":"","name":"onAnimationEndCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIteration":{"defaultValue":null,"description":"","name":"onAnimationIteration","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIterationCapture":{"defaultValue":null,"description":"","name":"onAnimationIterationCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onTransitionEnd":{"defaultValue":null,"description":"","name":"onTransitionEnd","required":false,"type":{"name":"TransitionEventHandler"}},"onTransitionEndCapture":{"defaultValue":null,"description":"","name":"onTransitionEndCapture","required":false,"type":{"name":"TransitionEventHandler"}},"transitionEnd":{"defaultValue":null,"description":"Custom `transitionEnd` definition for `enter` and `exit`","name":"transitionEnd","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/transition/dist/transition-utils.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial>>"}},"delay":{"defaultValue":null,"description":"Custom `delay` definition for `enter` and `exit`","name":"delay","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/transition/dist/transition-utils.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number | Partial>"}},"unmountOnExit":{"defaultValue":null,"description":"If `true`, the element will unmount when `in={false}` and animation is done","name":"unmountOnExit","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/transition/dist/transition-utils.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"in":{"defaultValue":null,"description":"Show the component; triggers when enter or exit states","name":"in","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/transition/dist/transition-utils.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/CommandBar.json b/tooling/props-docs/dist/components/CommandBar.json new file mode 100644 index 000000000..a328f500c --- /dev/null +++ b/tooling/props-docs/dist/components/CommandBar.json @@ -0,0 +1,164 @@ +{ + "CommandBar": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "isOpen": { "type": "boolean", "required": false }, + "onChange": { "type": "(search: string) => void", "required": false }, + "onClose": { "type": "() => void", "required": false }, + "onFilter": { + "type": "(string: string, search: string) => number", + "required": false + }, + "onSelect": { "type": "(value: string) => void", "required": false }, + "shouldFilter": { "type": "boolean", "required": false }, + "size": { "type": "ResponsiveValue", "required": false }, + "value": { "type": "string", "required": false } + }, + "CommandBarDialog": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "contentProps": { "type": "ModalContentProps", "required": false }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "CommandBarItem": { + "isDisabled": { "type": "boolean", "required": false }, + "onSelect": { "type": "(value: string) => void", "required": false }, + "value": { "type": "string", "required": false } + }, + "CommandBarInput": { + "onChange": { "type": "(value: string) => void", "required": false }, + "value": { "type": "string", "required": false } + }, + "CommandBarOptions": { + "closeOnSelect": { "type": "boolean", "required": false }, + "isOpen": { "type": "boolean", "required": false }, + "onChange": { "type": "(search: string) => void", "required": false }, + "onClose": { "type": "() => void", "required": false }, + "onFilter": { + "type": "(string: string, search: string) => number", + "required": false + }, + "onSelect": { "type": "(value: string) => void", "required": false }, + "shouldFilter": { "type": "boolean", "required": false }, + "size": { "type": "ResponsiveValue", "required": false }, + "value": { "type": "string", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/ConfirmDialog.json b/tooling/props-docs/dist/components/ConfirmDialog.json new file mode 100644 index 000000000..b8eb90d8e --- /dev/null +++ b/tooling/props-docs/dist/components/ConfirmDialog.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"ConfirmDialog","methods":[],"props":{"title":{"defaultValue":null,"description":"The dialog title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ReactNode"}},"cancelLabel":{"defaultValue":null,"description":"The cancel button label","name":"cancelLabel","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ReactNode"}},"confirmLabel":{"defaultValue":null,"description":"The confirm button label","name":"confirmLabel","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ReactNode"}},"cancelProps":{"defaultValue":null,"description":"The cancel button props","name":"cancelProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ButtonProps"}},"confirmProps":{"defaultValue":null,"description":"The confirm button props","name":"confirmProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ButtonProps"}},"buttonGroupProps":{"defaultValue":null,"description":"The button group props","name":"buttonGroupProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"ButtonGroupProps"}},"closeOnCancel":{"defaultValue":{"value":"true"},"description":"Close the dialog on cancel","name":"closeOnCancel","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"boolean"}},"closeOnConfirm":{"defaultValue":{"value":"true"},"description":"Close the dialog on confirm","name":"closeOnConfirm","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"boolean"}},"leastDestructiveFocus":{"defaultValue":null,"description":"Defines which button gets initial focus\nhttps://www.w3.org/TR/wai-aria-practices/#alertdialog","name":"leastDestructiveFocus","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"\"cancel\" | \"confirm\""}},"onCancel":{"defaultValue":null,"description":"Function that's called when cancel is clicked","name":"onCancel","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"(() => void)"}},"onConfirm":{"defaultValue":null,"description":"Function that's called when confirm is clicked","name":"onConfirm","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ConfirmDialogProps"}],"required":false,"type":{"name":"(() => void)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ContextMenuItem.json b/tooling/props-docs/dist/components/ContextMenuItem.json new file mode 100644 index 000000000..a30cc5e16 --- /dev/null +++ b/tooling/props-docs/dist/components/ContextMenuItem.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ContextMenuItem","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DataGrid.json b/tooling/props-docs/dist/components/DataGrid.json new file mode 100644 index 000000000..f661de7ff --- /dev/null +++ b/tooling/props-docs/dist/components/DataGrid.json @@ -0,0 +1,513 @@ +{ + "DataGridHeader": { + "header": { "type": "Header", "required": true }, + "isSortable": { "type": "boolean", "required": false } + }, + "DataGrid": { + "columns": { + "type": "ColumnDef[]", + "required": true, + "description": "The array of column defs to use for the table." + }, + "data": { + "type": "Data[]", + "required": true, + "description": "The data for the table to display. This array should match the type you provided to `table.setRowType<...>`. Columns can access this data via string/index or a functional accessor. When the `data` option changes reference, the table will reprocess the data." + }, + "aggregationFns": { + "type": "Record>", + "required": false + }, + "autoResetAll": { + "type": "boolean", + "required": false, + "description": "Set this option to override any of the `autoReset...` feature options." + }, + "autoResetExpanded": { + "type": "boolean", + "required": false, + "description": "Enable this setting to automatically reset the expanded state of the table when expanding state changes." + }, + "autoResetPageIndex": { + "type": "boolean", + "required": false, + "description": "If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "DataGrid children" + }, + "className": { + "type": "string", + "required": false, + "description": "The table class name attribute" + }, + "columnResizeDirection": { + "type": "ColumnResizeDirection", + "required": false, + "description": "Enables or disables right-to-left support for resizing the column. defaults to 'ltr'." + }, + "columnResizeMode": { + "type": "ColumnResizeMode", + "required": false, + "description": "Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle." + }, + "debugAll": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output all debugging information to the console." + }, + "debugColumns": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output column debugging information to the console." + }, + "debugHeaders": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output header debugging information to the console." + }, + "debugRows": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output row debugging information to the console." + }, + "debugTable": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output table debugging information to the console." + }, + "defaultColumn": { + "type": "Partial>", + "required": false, + "description": "Default column options to use for all column defs supplied to the table." + }, + "enableColumnFilters": { + "type": "boolean", + "required": false, + "description": "Enables/disables **column** filtering for all columns." + }, + "enableColumnPinning": { + "type": "boolean", + "required": false, + "description": "Enables/disables column pinning for the table. Defaults to `true`." + }, + "enableColumnResizing": { + "type": "boolean", + "required": false, + "description": "Enables or disables column resizing for the column." + }, + "enableExpanding": { + "type": "boolean", + "required": false, + "description": "Enable/disable expanding for all rows." + }, + "enableFilters": { + "type": "boolean", + "required": false, + "description": "Enables/disables all filtering for the table." + }, + "enableGlobalFilter": { + "type": "boolean", + "required": false, + "description": "Enables/disables **global** filtering for all columns." + }, + "enableGrouping": { + "type": "boolean", + "required": false, + "description": "Enables/disables grouping for the table." + }, + "enableHiding": { "type": "boolean", "required": false }, + "enableMultiRemove": { + "type": "boolean", + "required": false, + "description": "Enables/disables the ability to remove multi-sorts" + }, + "enableMultiRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "- Enables/disables multiple row selection for all rows in the table OR\n- A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren" + }, + "enableMultiSort": { + "type": "boolean", + "required": false, + "description": "Enables/Disables multi-sorting for the table." + }, + "enablePinning": { + "type": "boolean", + "required": false, + "description": "Enables/disables all pinning for the table. Defaults to `true`." + }, + "enableRowPinning": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "Enables/disables row pinning for the table. Defaults to `true`." + }, + "enableRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "- Enables/disables row selection for all rows in the table OR\n- A function that given a row, returns whether to enable/disable row selection for that row" + }, + "enableSorting": { + "type": "boolean", + "required": false, + "description": "Enables/Disables sorting for the table." + }, + "enableSortingRemoval": { + "type": "boolean", + "required": false, + "description": "Enables/Disables the ability to remove sorting for the table.\n- If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...\n- If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ..." + }, + "enableSubRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row.\n(Use in combination with expanding or grouping features)" + }, + "filterFns": { "type": "Record>", "required": false }, + "filterFromLeafRows": { + "type": "boolean", + "required": false, + "description": "By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included)." + }, + "getColumnCanGlobalFilter": { + "type": "(column: Column) => boolean", + "required": false, + "description": "If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.\n\nThis is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`)." + }, + "getExpandedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "This function is responsible for returning the expanded row model. If this function is not provided, the table will not expand rows. You can use the default exported `getExpandedRowModel` function to get the expanded row model or implement your own." + }, + "getFacetedMinMaxValues": { + "type": "(\n table: Table,\n columnId: string\n) => () => [number, number] | undefined", + "required": false + }, + "getFacetedRowModel": { + "type": "(\n table: Table,\n columnId: string\n) => () => RowModel", + "required": false + }, + "getFacetedUniqueValues": { + "type": "(\n table: Table,\n columnId: string\n) => () => Map", + "required": false + }, + "getFilteredRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered.\n- For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.\n- For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export." + }, + "getGroupedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "Returns the row model after grouping has taken place, but no further." + }, + "getIsRowExpanded": { + "type": "(row: Row) => boolean", + "required": false, + "description": "If provided, allows you to override the default behavior of determining whether a row is currently expanded." + }, + "getPaginationRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "Returns the row model after pagination has taken place, but no further.\n\nPagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here." + }, + "getRowCanExpand": { + "type": "(row: Row) => boolean", + "required": false, + "description": "If provided, allows you to override the default behavior of determining whether a row can be expanded." + }, + "getRowId": { + "type": "(\n originalRow: Data,\n index: number,\n parent?: Row | undefined\n) => string", + "required": false, + "description": "This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc." + }, + "getSortedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own." + }, + "getSubRows": { + "type": "(originalRow: Data, index: number) => Data[] | undefined", + "required": false, + "description": "This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row." + }, + "globalFilterFn": { + "type": "FilterFnOption", + "required": false, + "description": "The filter function to use for global filtering.\n- A `string` referencing a built-in filter function\n- A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option\n- A custom filter function" + }, + "groupedColumnMode": { + "type": "false | \"reorder\" | \"remove\"", + "required": false, + "description": "Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here." + }, + "initialState": { + "type": "InitialTableState", + "required": false, + "description": "Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.\n\nTable state will not be reset when this object changes, which also means that the initial state object does not need to be stable." + }, + "instanceRef": { + "type": "type ONLY_FOR_FORMAT =\n | ((instance: Table | null) => void)\n | RefObject>", + "required": false, + "description": "The React Table instance reference" + }, + "isExpandable": { + "type": "boolean", + "required": false, + "description": "Enable expandable rows" + }, + "isHoverable": { + "type": "boolean", + "required": false, + "description": "Enable row hover styles" + }, + "isMultiSortEvent": { + "type": "(e: unknown) => boolean", + "required": false, + "description": "Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return `true` if the event should trigger a multi-sort." + }, + "isSelectable": { + "type": "boolean", + "required": false, + "description": "Enable row selection" + }, + "isSortable": { + "type": "boolean", + "required": false, + "description": "Enable sorting on all columns" + }, + "keepPinnedRows": { + "type": "boolean", + "required": false, + "description": "When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`." + }, + "manualExpanding": { + "type": "boolean", + "required": false, + "description": "Enables manual row expansion. If this is set to `true`, `getExpandedRowModel` will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion." + }, + "manualFiltering": { + "type": "boolean", + "required": false, + "description": "Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering." + }, + "manualGrouping": { + "type": "boolean", + "required": false, + "description": "Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation." + }, + "manualPagination": { + "type": "boolean", + "required": false, + "description": "Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginationRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation." + }, + "manualSorting": { + "type": "boolean", + "required": false, + "description": "Enables manual sorting for the table. If this is `true`, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting." + }, + "maxLeafRowFilterDepth": { + "type": "number", + "required": false, + "description": "By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on.\n\nThis is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter." + }, + "maxMultiSortColCount": { + "type": "number", + "required": false, + "description": "Set a maximum number of columns that can be multi-sorted." + }, + "mergeOptions": { + "type": "(\n defaultOptions: TableOptions,\n options: Partial>\n) => TableOptions", + "required": false, + "description": "This option is used to optionally implement the merging of table options." + }, + "meta": { + "type": "TableMeta", + "required": false, + "description": "You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`." + }, + "noResults": { + "type": "FC", + "required": false, + "description": "No results component" + }, + "onColumnFiltersChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnFilters` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onColumnOrderChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onColumnPinningChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state." + }, + "onColumnSizingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state." + }, + "onColumnSizingInfoChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnSizingInfo` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizingInfo` from your own managed state." + }, + "onColumnVisibilityChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnVisibility` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onExpandedChange": { + "type": "OnChangeFn", + "required": false, + "description": "This function is called when the `expanded` table state changes. If a function is provided, you will be responsible for managing this state on your own. To pass the managed state back to the table, use the `tableOptions.state.expanded` option." + }, + "onGlobalFilterChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.globalFilter` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onGroupingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.grouping` option." + }, + "onPaginationChange": { + "type": "OnChangeFn", + "required": false, + "description": "If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option." + }, + "onResetFilters": { + "type": "() => void", + "required": false, + "description": "Callback fired when clear filters is clicked." + }, + "onRowClick": { + "type": "(\n row: Row,\n e: MouseEvent,\n meta?: any\n) => void", + "required": false, + "description": "Callback fired when a row is clicked." + }, + "onRowPinningChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state." + }, + "onRowSelectionChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onScroll": { + "type": "UIEventHandler", + "required": false, + "description": "Callback fired when the grid is scrolled." + }, + "onSelectedRowsChange": { + "type": "(rows: string[]) => void", + "required": false, + "description": "Triggers whenever the row selection changes." + }, + "onSortChange": { + "type": "(columns: ColumnSort[]) => void", + "required": false, + "description": "Triggers when sort changed.\nUse incombination with `manualSortBy` to enable remote sorting." + }, + "onSortingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onStateChange": { + "type": "(updater: Updater) => void", + "required": false, + "description": "The `onStateChange` option can be used to optionally listen to state changes within the table." + }, + "pageCount": { + "type": "number", + "required": false, + "description": "Use this for controlled pagination." + }, + "paginateExpandedRows": { + "type": "boolean", + "required": false, + "description": "If `true` expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If `false` expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size)" + }, + "renderFallbackValue": { + "type": "any", + "required": false, + "description": "Value used when the desired value is not found in the data." + }, + "sortDescFirst": { + "type": "boolean", + "required": false, + "description": "If `true`, all sorts will default to descending as their first toggle state." + }, + "sortingFns": { + "type": "Record>", + "required": false + }, + "state": { + "type": "Partial", + "required": false, + "description": "The `state` option can be used to optionally _control_ part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the `onStateChange` option.\n> Note: Any state passed in here will override both the internal state and any other `initialState` you provide." + }, + "sx": { + "type": "SystemStyleObject", + "required": false, + "description": "Grid styles" + }, + "tableLayout": { + "type": "\"auto\" | \"fixed\"", + "defaultValue": "fixed", + "required": false, + "description": "CSS table-layout property" + }, + "virtualizerProps": { + "type": "VirtualizerOptions", + "required": false, + "description": "React Virtual props" + } + }, + "DataGridProvider": { + "instance": { "type": "Table", "required": true }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "DataGridSort": { + "header": { "type": "Header", "required": true } + }, + "UseColumnVisibility": { + "columns": { "type": "ColumnDef[]", "required": true }, + "visibleColumns": { + "type": "NonNullable", + "required": false + } + }, + "DataGridPagination": { + "onChange": { + "type": "(props: { pageIndex: number; pageSize: number }) => void", + "required": false + } + }, + "NoResults": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "clearLabel": { "type": "string", "required": false }, + "onReset": { "type": "() => void", "required": false }, + "resource": { "type": "string", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | \"auto\"\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false + }, + "title": { "type": "string", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/DataTable.json b/tooling/props-docs/dist/components/DataTable.json new file mode 100644 index 000000000..2eb14e27a --- /dev/null +++ b/tooling/props-docs/dist/components/DataTable.json @@ -0,0 +1,423 @@ +{ + "DataTable": { + "columns": { + "type": "ColumnDef[]", + "required": true, + "description": "The array of column defs to use for the table." + }, + "data": { + "type": "Data[]", + "required": true, + "description": "The data for the table to display. This array should match the type you provided to `table.setRowType<...>`. Columns can access this data via string/index or a functional accessor. When the `data` option changes reference, the table will reprocess the data." + }, + "aggregationFns": { + "type": "Record>", + "required": false + }, + "autoResetAll": { + "type": "boolean", + "required": false, + "description": "Set this option to override any of the `autoReset...` feature options." + }, + "autoResetExpanded": { + "type": "boolean", + "required": false, + "description": "Enable this setting to automatically reset the expanded state of the table when expanding state changes." + }, + "autoResetPageIndex": { + "type": "boolean", + "required": false, + "description": "If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc." + }, + "className": { + "type": "string", + "required": false, + "description": "The table class name attribute" + }, + "columnResizeMode": { + "type": "ColumnResizeMode", + "required": false, + "description": "Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle." + }, + "debugAll": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output all debugging information to the console." + }, + "debugColumns": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output column debugging information to the console." + }, + "debugHeaders": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output header debugging information to the console." + }, + "debugRows": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output row debugging information to the console." + }, + "debugTable": { + "type": "boolean", + "required": false, + "description": "Set this option to `true` to output table debugging information to the console." + }, + "defaultColumn": { + "type": "Partial>", + "required": false, + "description": "Default column options to use for all column defs supplied to the table." + }, + "enableColumnFilters": { + "type": "boolean", + "required": false, + "description": "Enables/disables **column** filtering for all columns." + }, + "enableColumnPinning": { + "type": "boolean", + "required": false, + "description": "Enables/disables column pinning for the table. Defaults to `true`." + }, + "enableColumnResizing": { + "type": "boolean", + "required": false, + "description": "Enables or disables column resizing for the column." + }, + "enableExpanding": { + "type": "boolean", + "required": false, + "description": "Enable/disable expanding for all rows." + }, + "enableFilters": { + "type": "boolean", + "required": false, + "description": "Enables/disables all filtering for the table." + }, + "enableGlobalFilter": { + "type": "boolean", + "required": false, + "description": "Enables/disables **global** filtering for all columns." + }, + "enableGrouping": { + "type": "boolean", + "required": false, + "description": "Enables/disables grouping for the table." + }, + "enableHiding": { "type": "boolean", "required": false }, + "enableMultiRemove": { + "type": "boolean", + "required": false, + "description": "Enables/disables the ability to remove multi-sorts" + }, + "enableMultiRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "- Enables/disables multiple row selection for all rows in the table OR\n- A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren" + }, + "enableMultiSort": { + "type": "boolean", + "required": false, + "description": "Enables/Disables multi-sorting for the table." + }, + "enablePinning": { + "type": "boolean", + "required": false, + "description": "Enables/disables all pinning for the table. Defaults to `true`." + }, + "enableRowPinning": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "Enables/disables row pinning for the table. Defaults to `true`." + }, + "enableRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "- Enables/disables row selection for all rows in the table OR\n- A function that given a row, returns whether to enable/disable row selection for that row" + }, + "enableSorting": { + "type": "boolean", + "required": false, + "description": "Enables/Disables sorting for the table." + }, + "enableSortingRemoval": { + "type": "boolean", + "required": false, + "description": "Enables/Disables the ability to remove sorting for the table.\n- If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...\n- If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ..." + }, + "enableSubRowSelection": { + "type": "boolean | ((row: Row) => boolean)", + "required": false, + "description": "Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row.\n(Use in combination with expanding or grouping features)" + }, + "filterFns": { "type": "Record>", "required": false }, + "filterFromLeafRows": { + "type": "boolean", + "required": false, + "description": "By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included)." + }, + "getColumnCanGlobalFilter": { + "type": "(column: Column) => boolean", + "required": false, + "description": "If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.\n\nThis is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`)." + }, + "getExpandedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "This function is responsible for returning the expanded row model. If this function is not provided, the table will not expand rows. You can use the default exported `getExpandedRowModel` function to get the expanded row model or implement your own." + }, + "getFacetedMinMaxValues": { + "type": "(\n table: Table,\n columnId: string\n) => () => [number, number] | undefined", + "required": false + }, + "getFacetedRowModel": { + "type": "(\n table: Table,\n columnId: string\n) => () => RowModel", + "required": false + }, + "getFacetedUniqueValues": { + "type": "(\n table: Table,\n columnId: string\n) => () => Map", + "required": false + }, + "getFilteredRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered.\n- For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.\n- For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export." + }, + "getGroupedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "Returns the row model after grouping has taken place, but no further." + }, + "getIsRowExpanded": { + "type": "(row: Row) => boolean", + "required": false, + "description": "If provided, allows you to override the default behavior of determining whether a row is currently expanded." + }, + "getPaginationRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "Returns the row model after pagination has taken place, but no further.\n\nPagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here." + }, + "getRowCanExpand": { + "type": "(row: Row) => boolean", + "required": false, + "description": "If provided, allows you to override the default behavior of determining whether a row can be expanded." + }, + "getRowId": { + "type": "(\n originalRow: Data,\n index: number,\n parent?: Row | undefined\n) => string", + "required": false, + "description": "This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc." + }, + "getSortedRowModel": { + "type": "(table: Table) => () => RowModel", + "required": false, + "description": "This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own." + }, + "getSubRows": { + "type": "(originalRow: Data, index: number) => Data[] | undefined", + "required": false, + "description": "This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row." + }, + "globalFilterFn": { + "type": "FilterFnOption", + "required": false, + "description": "The filter function to use for global filtering.\n- A `string` referencing a built-in filter function\n- A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option\n- A custom filter function" + }, + "groupedColumnMode": { + "type": "false | \"reorder\" | \"remove\"", + "required": false, + "description": "Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here." + }, + "initialState": { + "type": "InitialTableState", + "required": false, + "description": "Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.\n\nTable state will not be reset when this object changes, which also means that the initial state object does not need to be stable." + }, + "instanceRef": { + "type": "type ONLY_FOR_FORMAT =\n | ((instance: Table | null) => void)\n | RefObject>", + "required": false, + "description": "The TableInstance reference" + }, + "isMultiSortEvent": { + "type": "(e: unknown) => boolean", + "required": false, + "description": "Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return `true` if the event should trigger a multi-sort." + }, + "isSelectable": { + "type": "boolean", + "required": false, + "description": "Enable row selection" + }, + "isSortable": { + "type": "boolean", + "required": false, + "description": "Enable sorting on all columns" + }, + "keepPinnedRows": { + "type": "boolean", + "required": false, + "description": "When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`." + }, + "manualExpanding": { + "type": "boolean", + "required": false, + "description": "Enables manual row expansion. If this is set to `true`, `getExpandedRowModel` will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion." + }, + "manualFiltering": { + "type": "boolean", + "required": false, + "description": "Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering." + }, + "manualGrouping": { + "type": "boolean", + "required": false, + "description": "Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation." + }, + "manualPagination": { + "type": "boolean", + "required": false, + "description": "Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginationRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation." + }, + "manualSorting": { + "type": "boolean", + "required": false, + "description": "Enables manual sorting for the table. If this is `true`, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting." + }, + "maxLeafRowFilterDepth": { + "type": "number", + "required": false, + "description": "By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on.\n\nThis is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter." + }, + "maxMultiSortColCount": { + "type": "number", + "required": false, + "description": "Set a maximum number of columns that can be multi-sorted." + }, + "mergeOptions": { + "type": "(\n defaultOptions: TableOptions,\n options: Partial>\n) => TableOptions", + "required": false, + "description": "This option is used to optionally implement the merging of table options." + }, + "meta": { + "type": "TableMeta", + "required": false, + "description": "You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`." + }, + "onColumnFiltersChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnFilters` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onColumnOrderChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onColumnPinningChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state." + }, + "onColumnSizingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state." + }, + "onColumnSizingInfoChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnSizingInfo` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizingInfo` from your own managed state." + }, + "onColumnVisibilityChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.columnVisibility` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onExpandedChange": { + "type": "OnChangeFn", + "required": false, + "description": "This function is called when the `expanded` table state changes. If a function is provided, you will be responsible for managing this state on your own. To pass the managed state back to the table, use the `tableOptions.state.expanded` option." + }, + "onGlobalFilterChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.globalFilter` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onGroupingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.grouping` option." + }, + "onPaginationChange": { + "type": "OnChangeFn", + "required": false, + "description": "If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option." + }, + "onRowPinningChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state." + }, + "onRowSelectionChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onSelectedRowsChange": { + "type": "(rows: string[]) => void", + "required": false, + "description": "Triggers whenever the row selection changes." + }, + "onSortChange": { + "type": "(columns: ColumnSort[]) => void", + "required": false, + "description": "Triggers when sort changed.\nUse incombination with `manualSortBy` to enable remote sorting." + }, + "onSortingChange": { + "type": "OnChangeFn", + "required": false, + "description": "If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table." + }, + "onStateChange": { + "type": "(updater: Updater) => void", + "required": false, + "description": "The `onStateChange` option can be used to optionally listen to state changes within the table." + }, + "pageCount": { + "type": "number", + "required": false, + "description": "When manually controlling pagination, you should supply a total `pageCount` value to the table if you know it. If you do not know how many pages there are, you can set this to `-1`." + }, + "paginateExpandedRows": { + "type": "boolean", + "required": false, + "description": "If `true` expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If `false` expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size)" + }, + "renderFallbackValue": { + "type": "any", + "required": false, + "description": "Value used when the desired value is not found in the data." + }, + "sortDescFirst": { + "type": "boolean", + "required": false, + "description": "If `true`, all sorts will default to descending as their first toggle state." + }, + "sortingFns": { + "type": "Record>", + "required": false + }, + "state": { + "type": "Partial", + "required": false, + "description": "The `state` option can be used to optionally _control_ part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the `onStateChange` option.\n> Note: Any state passed in here will override both the internal state and any other `initialState` you provide." + } + }, + "DataTableSort": { + "header": { "type": "Header", "required": true } + }, + "DataTableHeader": { + "header": { "type": "Header", "required": true }, + "isSortable": { "type": "boolean", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/DataTableHeader.json b/tooling/props-docs/dist/components/DataTableHeader.json new file mode 100644 index 000000000..264bbd284 --- /dev/null +++ b/tooling/props-docs/dist/components/DataTableHeader.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-data-table/src/index.ts","description":"","displayName":"DataTableHeader","methods":[],"props":{"header":{"defaultValue":null,"description":"","name":"header","parent":{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableHeaderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableHeaderProps"}],"required":true,"type":{"name":"Header"}},"isSortable":{"defaultValue":null,"description":"","name":"isSortable","parent":{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableHeaderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableHeaderProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DataTableSort.json b/tooling/props-docs/dist/components/DataTableSort.json new file mode 100644 index 000000000..2165f59c9 --- /dev/null +++ b/tooling/props-docs/dist/components/DataTableSort.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-data-table/src/index.ts","description":"","displayName":"DataTableSort","methods":[],"props":{"header":{"defaultValue":null,"description":"","name":"header","parent":{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableSortProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-data-table/src/data-table.tsx","name":"DataTableSortProps"}],"required":true,"type":{"name":"Header"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePicker.json b/tooling/props-docs/dist/components/DatePicker.json new file mode 100644 index 000000000..d124d5926 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePicker.json @@ -0,0 +1,3263 @@ +{ + "DatePicker": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "required": false, + "description": "Whether the element should receive focus on render." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { "type": "DateValue", "required": false }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (controlled)." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "locale": { "type": "string", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "maxValue": { "type": "DateValue", "required": false }, + "minValue": { "type": "DateValue", "required": false }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(value: DateValue | null) => void", + "required": false + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "timeZone": { "type": "string", "required": false }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + }, + "validate": { + "type": "(\n value: DateValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateValue", "required": false } + }, + "DatePickerContainer": { + "autoFocus": { + "type": "boolean", + "required": false, + "description": "Whether the element should receive focus on render." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((args_0: DatePickerState) => ReactNode)", + "required": false + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { "type": "DateValue", "required": false }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (controlled)." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "locale": { "type": "string", "required": false }, + "maxValue": { "type": "DateValue", "required": false }, + "minValue": { "type": "DateValue", "required": false }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(value: DateValue | null) => void", + "required": false + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "timeZone": { "type": "string", "required": false }, + "validate": { + "type": "(\n value: DateValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateValue", "required": false } + }, + "DatePickerStatic": { + "autoFocus": { + "type": "boolean", + "required": false, + "description": "Whether the element should receive focus on render." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((args_0: DatePickerState) => ReactNode)", + "required": false + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { "type": "DateValue", "required": false }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (controlled)." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "locale": { "type": "string", "required": false }, + "maxValue": { "type": "DateValue", "required": false }, + "minValue": { "type": "DateValue", "required": false }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(value: DateValue | null) => void", + "required": false + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "timeZone": { "type": "string", "required": false }, + "validate": { + "type": "(\n value: DateValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateValue", "required": false } + }, + "DatePickerDialog": { + "_dragX": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "_dragY": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "about": { "type": "string", "required": false }, + "accessKey": { "type": "string", "required": false }, + "animate": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | TargetAndTransition\n | AnimationControls\n | VariantLabels", + "required": false, + "description": "Values to animate to, variant label(s), or `AnimationControls`.\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// AnimationControls\n\n```" + }, + "aria-activedescendant": { "type": "string", "required": false }, + "aria-atomic": { "type": "Booleanish", "required": false }, + "aria-autocomplete": { + "type": "\"list\" | \"none\" | \"inline\" | \"both\"", + "required": false + }, + "aria-braillelabel": { "type": "string", "required": false }, + "aria-brailleroledescription": { "type": "string", "required": false }, + "aria-busy": { "type": "Booleanish", "required": false }, + "aria-checked": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-colcount": { "type": "number", "required": false }, + "aria-colindex": { "type": "number", "required": false }, + "aria-colindextext": { "type": "string", "required": false }, + "aria-colspan": { "type": "number", "required": false }, + "aria-controls": { "type": "string", "required": false }, + "aria-current": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"time\"\n | \"true\"\n | \"false\"\n | \"step\"\n | \"page\"\n | \"location\"\n | \"date\"", + "required": false + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-description": { "type": "string", "required": false }, + "aria-details": { "type": "string", "required": false }, + "aria-disabled": { "type": "Booleanish", "required": false }, + "aria-dropeffect": { + "type": "\"link\" | \"none\" | \"copy\" | \"execute\" | \"move\" | \"popup\"", + "required": false + }, + "aria-errormessage": { "type": "string", "required": false }, + "aria-expanded": { "type": "Booleanish", "required": false }, + "aria-flowto": { "type": "string", "required": false }, + "aria-grabbed": { "type": "Booleanish", "required": false }, + "aria-haspopup": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"dialog\"\n | \"menu\"\n | \"true\"\n | \"false\"\n | \"grid\"\n | \"listbox\"\n | \"tree\"", + "required": false + }, + "aria-hidden": { "type": "Booleanish", "required": false }, + "aria-invalid": { + "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", + "required": false + }, + "aria-keyshortcuts": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "aria-level": { "type": "number", "required": false }, + "aria-live": { + "type": "\"off\" | \"assertive\" | \"polite\"", + "required": false + }, + "aria-modal": { "type": "Booleanish", "required": false }, + "aria-multiline": { "type": "Booleanish", "required": false }, + "aria-multiselectable": { "type": "Booleanish", "required": false }, + "aria-orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "aria-owns": { "type": "string", "required": false }, + "aria-placeholder": { "type": "string", "required": false }, + "aria-posinset": { "type": "number", "required": false }, + "aria-pressed": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-readonly": { "type": "Booleanish", "required": false }, + "aria-relevant": { + "type": "type ONLY_FOR_FORMAT =\n | \"text\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"all\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", + "required": false + }, + "aria-required": { "type": "Booleanish", "required": false }, + "aria-roledescription": { "type": "string", "required": false }, + "aria-rowcount": { "type": "number", "required": false }, + "aria-rowindex": { "type": "number", "required": false }, + "aria-rowindextext": { "type": "string", "required": false }, + "aria-rowspan": { "type": "number", "required": false }, + "aria-selected": { "type": "Booleanish", "required": false }, + "aria-setsize": { "type": "number", "required": false }, + "aria-sort": { + "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", + "required": false + }, + "aria-valuemax": { "type": "number", "required": false }, + "aria-valuemin": { "type": "number", "required": false }, + "aria-valuenow": { "type": "number", "required": false }, + "aria-valuetext": { "type": "string", "required": false }, + "autoCapitalize": { "type": "string", "required": false }, + "autoCorrect": { "type": "string", "required": false }, + "autoFocus": { "type": "boolean", "required": false }, + "autoSave": { "type": "string", "required": false }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The DatePickerDialog children" + }, + "className": { "type": "string", "required": false }, + "color": { "type": "string", "required": false }, + "content": { "type": "string", "required": false }, + "contentEditable": { + "type": "\"inherit\" | Booleanish", + "required": false + }, + "contextMenu": { "type": "string", "required": false }, + "custom": { + "type": "any", + "required": false, + "description": "Custom data to use to resolve dynamic variants differently for each animating component.\n\n```jsx\nconst variants = {\n visible: (custom) => ({\n opacity: 1,\n transition: { delay: custom * 0.2 }\n })\n}\n\n\n\n\n```" + }, + "dangerouslySetInnerHTML": { + "type": "{ __html: string | TrustedHTML }", + "required": false + }, + "datatype": { "type": "string", "required": false }, + "defaultChecked": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | number | readonly string[]", + "required": false + }, + "dir": { "type": "string", "required": false }, + "drag": { + "type": "boolean | \"x\" | \"y\"", + "required": false, + "description": "Enable dragging for this element. Set to `false` by default.\nSet `true` to drag in both directions.\nSet `\"x\"` or `\"y\"` to only drag in a specific direction.\n\n```jsx\n\n```" + }, + "dragConstraints": { + "type": "false | Partial | RefObject", + "required": false, + "description": "Applies constraints on the permitted draggable area.\n\nIt can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels.\nThis will define a distance the named edge of the draggable component.\n\nAlternatively, it can accept a `ref` to another component created with React's `useRef` hook.\nThis `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref`\nof the component you want to use as constraints.\n\n```jsx\n// In pixels\n\n\n// As a ref to another component\nconst MyComponent = () => {\n const constraintsRef = useRef(null)\n\n return (\n \n \n \n )\n}\n```" + }, + "dragControls": { + "type": "DragControls", + "required": false, + "description": "Usually, dragging is initiated by pressing down on a component and moving it. For some\nuse-cases, for instance clicking at an arbitrary point on a video scrubber, we\nmight want to initiate dragging from a different component than the draggable one.\n\nBy creating a `dragControls` using the `useDragControls` hook, we can pass this into\nthe draggable component's `dragControls` prop. It exposes a `start` method\nthat can start dragging from pointer events on other components.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragDirectionLock": { + "type": "boolean", + "required": false, + "description": "If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n\n```jsx\n\n```" + }, + "dragElastic": { + "type": "DragElastic", + "required": false, + "description": "The degree of movement allowed outside constraints. 0 = no movement, 1 =\nfull movement.\n\nSet to `0.5` by default. Can also be set as `false` to disable movement.\n\nBy passing an object of `top`/`right`/`bottom`/`left`, individual values can be set\nper constraint. Any missing values will be set to `0`.\n\n```jsx\n\n```" + }, + "draggable": { "type": "Booleanish", "required": false }, + "dragListener": { + "type": "boolean", + "required": false, + "description": "By default, if `drag` is defined on a component then an event listener will be attached\nto automatically initiate dragging when a user presses down on it.\n\nBy setting `dragListener` to `false`, this event listener will not be created.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragMomentum": { + "type": "boolean", + "required": false, + "description": "Apply momentum from the pan gesture to the component when dragging\nfinishes. Set to `true` by default.\n\n```jsx\n\n```" + }, + "dragPropagation": { + "type": "boolean", + "required": false, + "description": "Allows drag gesture propagation to child components. Set to `false` by\ndefault.\n\n```jsx\n\n```" + }, + "dragSnapToOrigin": { + "type": "boolean", + "required": false, + "description": "If true, element will snap back to its origin when dragging ends.\n\nEnabling this is the equivalent of setting all `dragConstraints` axes to `0`\nwith `dragElastic={1}`, but when used together `dragConstraints` can define\na wider draggable area and `dragSnapToOrigin` will ensure the element\nanimates back to its origin on release." + }, + "dragTransition": { + "type": "Partial>", + "required": false, + "description": "Allows you to change dragging inertia parameters.\nWhen releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it.\nSee \n{@link \nhttps://framer.com/api/animation/#inertia Inertia\n}\n for all properties you can use.\n\n```jsx\n\n```" + }, + "exit": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "A target to animate to when this component is removed from the tree.\n\nThis component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n\nThis limitation exists because React doesn't allow components to defer unmounting until after\nan animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n\n```jsx\nimport { AnimatePresence, motion } from 'framer-motion'\n\nexport const MyComponent = ({ isVisible }) => {\n return (\n \n {isVisible && (\n \n )}\n \n )\n}\n```" + }, + "hidden": { "type": "boolean", "required": false }, + "hideArrow": { + "type": "boolean", + "required": false, + "description": "Hide the arrow" + }, + "id": { "type": "string", "required": false }, + "ignoreStrict": { "type": "boolean", "required": false }, + "inherit": { "type": "boolean", "required": false }, + "initial": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | MakeCustomValueType\n | VariantLabels", + "required": false, + "description": "Properties, variant label or array of variant labels to start in.\n\nSet to `false` to initialise with the values in `animate` (disabling the mount animation)\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// As false (disable mount animation)\n\n```" + }, + "inlist": { "type": "any", "required": false }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"text\"\n | \"none\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"", + "required": false + }, + "is": { "type": "string", "required": false }, + "itemID": { "type": "string", "required": false }, + "itemProp": { "type": "string", "required": false }, + "itemRef": { "type": "string", "required": false }, + "itemScope": { "type": "boolean", "required": false }, + "itemType": { "type": "string", "required": false }, + "lang": { "type": "string", "required": false }, + "layout": { + "type": "boolean | \"position\" | \"size\" | \"preserve-aspect\"", + "required": false, + "description": "If `true`, this component will automatically animate to its new position when\nits layout changes.\n\n```jsx\n\n```\n\nThis will perform a layout animation using performant transforms. Part of this technique\ninvolved animating an element's scale. This can introduce visual distortions on children,\n`boxShadow` and `borderRadius`.\n\nTo correct distortion on immediate children, add `layout` to those too.\n\n`boxShadow` and `borderRadius` will automatically be corrected if they are already being\nanimated on this component. Otherwise, set them directly via the `initial` prop.\n\nIf `layout` is set to `\"position\"`, the size of the component will change instantly and\nonly its position will animate. If `layout` is set to `\"size\"`, the position of the\ncomponent will change instantly but its size will animate.\n\nIf `layout` is set to `\"size\"`, the position of the component will change instantly and\nonly its size will animate.\n\nIf `layout` is set to `\"preserve-aspect\"`, the component will animate size & position if\nthe aspect ratio remains the same between renders, and just position if the ratio changes." + }, + "layoutDependency": { "type": "any", "required": false }, + "layoutId": { + "type": "string", + "required": false, + "description": "Enable shared layout transitions between different components with the same `layoutId`.\n\nWhen a component with a layoutId is removed from the React tree, and then\nadded elsewhere, it will visually animate from the previous component's bounding box\nand its latest animated values.\n\n```jsx\n {items.map(item => (\n \n {item.name}\n {item.isSelected && }\n \n ))}\n```\n\nIf the previous component remains in the tree it will crossfade with the new component." + }, + "layoutRoot": { + "type": "boolean", + "required": false, + "description": "Whether an element should be considered a \"layout root\", where\nall children will be forced to resolve relatively to it.\nCurrently used for `position: sticky` elements in Framer." + }, + "layoutScroll": { + "type": "boolean", + "required": false, + "description": "Whether a projection node should measure its scroll when it or its descendants update their layout." + }, + "motionProps": { + "type": "HTMLMotionProps<\"section\">", + "required": false + }, + "nonce": { "type": "string", "required": false }, + "onAbort": { "type": "ReactEventHandler", "required": false }, + "onAbortCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onAnimationComplete": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` is complete.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has completed.\n\n```jsx\nfunction onComplete() {\n console.log(\"Animation completed\")\n}\n\n {\n console.log('Completed animating', definition)\n }}\n/>\n```" + }, + "onAnimationEnd": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationEndCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIteration": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIterationCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationStartCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAuxClick": { + "type": "MouseEventHandler", + "required": false + }, + "onAuxClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onBeforeInput": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeLayoutMeasure": { + "type": "(box: Box) => void", + "required": false + }, + "onBlur": { "type": "FocusEventHandler", "required": false }, + "onBlurCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onCanPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThrough": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThroughCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onChange": { "type": "FormEventHandler", "required": false }, + "onChangeCapture": { + "type": "FormEventHandler", + "required": false + }, + "onClick": { "type": "MouseEventHandler", "required": false }, + "onClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCompositionEnd": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionEndCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStart": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStartCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdate": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdateCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onContextMenu": { + "type": "MouseEventHandler", + "required": false + }, + "onContextMenuCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCopy": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCopyCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCut": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCutCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onDirectionLock": { + "type": "(axis: \"x\" | \"y\") => void", + "required": false, + "description": "Callback function that fires a drag direction is determined.\n\n```jsx\n console.log(axis)}\n/>\n```" + }, + "onDoubleClick": { + "type": "MouseEventHandler", + "required": false + }, + "onDoubleClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onDragCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEndCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnter": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnterCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragExit": { + "type": "DragEventHandler", + "required": false + }, + "onDragExitCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeave": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeaveCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragOver": { + "type": "DragEventHandler", + "required": false + }, + "onDragOverCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragStartCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragTransitionEnd": { + "type": "() => void", + "required": false, + "description": "Callback function that fires when drag momentum/bounce transition finishes.\n\n```jsx\n console.log('Drag transition complete')}\n/>\n```" + }, + "onDrop": { "type": "DragEventHandler", "required": false }, + "onDropCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDurationChange": { + "type": "ReactEventHandler", + "required": false + }, + "onDurationChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptied": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptiedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEncrypted": { + "type": "ReactEventHandler", + "required": false + }, + "onEncryptedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEnded": { "type": "ReactEventHandler", "required": false }, + "onEndedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onError": { "type": "ReactEventHandler", "required": false }, + "onErrorCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onFocus": { "type": "FocusEventHandler", "required": false }, + "onFocusCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onGotPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onGotPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onHoverEnd": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer stops hovering over the component.\n\n```jsx\n console.log(\"Hover ends\")} />\n```" + }, + "onHoverStart": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer starts hovering over the component.\n\n```jsx\n console.log('Hover starts')} />\n```" + }, + "onInput": { "type": "FormEventHandler", "required": false }, + "onInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onInvalid": { "type": "FormEventHandler", "required": false }, + "onInvalidCapture": { + "type": "FormEventHandler", + "required": false + }, + "onKeyDown": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyDownCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPress": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPressCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUp": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUpCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onLayoutAnimationComplete": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component completes." + }, + "onLayoutAnimationStart": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component starts." + }, + "onLayoutMeasure": { + "type": "(box: Box, prevBox: Box) => void", + "required": false + }, + "onLoad": { "type": "ReactEventHandler", "required": false }, + "onLoadCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedData": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedDataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadata": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStart": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStartCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLostPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onLostPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onMeasureDragConstraints": { + "type": "(constraints: BoundingBox) => void | BoundingBox", + "required": false, + "description": "If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints." + }, + "onMouseDown": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseDownCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseEnter": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseLeave": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMove": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMoveCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOut": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOutCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOver": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOverCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUp": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUpCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onPan": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture is recognised on this element.\n\n**Note:** For pan gestures to work correctly with touch input, the element needs\ntouch scrolling to be disabled on either x/y or both axis with the\n[touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) CSS rule.\n\n```jsx\nfunction onPan(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanEnd": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture ends on this element.\n\n```jsx\nfunction onPanEnd(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanSessionStart": { + "type": "(event: PointerEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when we begin detecting a pan gesture. This\nis analogous to `onMouseStart` or `onTouchStart`.\n\n```jsx\nfunction onPanSessionStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanStart": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture begins on this element.\n\n```jsx\nfunction onPanStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPaste": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPasteCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPause": { "type": "ReactEventHandler", "required": false }, + "onPauseCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlay": { "type": "ReactEventHandler", "required": false }, + "onPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlaying": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPointerCancel": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerCancelCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDown": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDownCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnter": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnterCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeave": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeaveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMove": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMoveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOut": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOutCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOver": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOverCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUp": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUpCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onProgress": { + "type": "ReactEventHandler", + "required": false + }, + "onProgressCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChange": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onReset": { "type": "FormEventHandler", "required": false }, + "onResetCapture": { + "type": "FormEventHandler", + "required": false + }, + "onResize": { "type": "ReactEventHandler", "required": false }, + "onResizeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onScroll": { "type": "UIEventHandler", "required": false }, + "onScrollCapture": { + "type": "UIEventHandler", + "required": false + }, + "onSeeked": { "type": "ReactEventHandler", "required": false }, + "onSeekedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSeeking": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSelect": { "type": "ReactEventHandler", "required": false }, + "onSelectCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onStalled": { + "type": "ReactEventHandler", + "required": false + }, + "onStalledCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSubmit": { "type": "FormEventHandler", "required": false }, + "onSubmitCapture": { + "type": "FormEventHandler", + "required": false + }, + "onSuspend": { + "type": "ReactEventHandler", + "required": false + }, + "onSuspendCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTap": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture successfully ends on this element.\n\n```jsx\nfunction onTap(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapCancel": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture ends outside this element.\n\n```jsx\nfunction onTapCancel(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture starts on this element.\n\n```jsx\nfunction onTapStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTimeUpdate": { + "type": "ReactEventHandler", + "required": false + }, + "onTimeUpdateCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTouchCancel": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchCancelCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEnd": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEndCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMove": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMoveCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStart": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStartCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTransitionEnd": { + "type": "TransitionEventHandler", + "required": false + }, + "onTransitionEndCapture": { + "type": "TransitionEventHandler", + "required": false + }, + "onUpdate": { + "type": "(latest: ResolvedValues) => void", + "required": false, + "description": "Callback with latest motion values, fired max once per frame.\n\n```jsx\nfunction onUpdate(latest) {\n console.log(latest.x, latest.opacity)\n}\n\n\n```" + }, + "onViewportEnter": { "type": "ViewportEventHandler", "required": false }, + "onViewportLeave": { "type": "ViewportEventHandler", "required": false }, + "onVolumeChange": { + "type": "ReactEventHandler", + "required": false + }, + "onVolumeChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWaiting": { + "type": "ReactEventHandler", + "required": false + }, + "onWaitingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWheel": { "type": "WheelEventHandler", "required": false }, + "onWheelCapture": { + "type": "WheelEventHandler", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "prefix": { "type": "string", "required": false }, + "property": { "type": "string", "required": false }, + "radioGroup": { "type": "string", "required": false }, + "rel": { "type": "string", "required": false }, + "resource": { "type": "string", "required": false }, + "results": { "type": "number", "required": false }, + "rev": { "type": "string", "required": false }, + "role": { "type": "AriaRole", "required": false }, + "rootProps": { "type": "HTMLChakraProps<\"div\">", "required": false }, + "security": { "type": "string", "required": false }, + "slot": { "type": "string", "required": false }, + "spellCheck": { "type": "Booleanish", "required": false }, + "suppressContentEditableWarning": { "type": "boolean", "required": false }, + "suppressHydrationWarning": { "type": "boolean", "required": false }, + "tabIndex": { "type": "number", "required": false }, + "title": { "type": "string", "required": false }, + "transformTemplate": { + "type": "(\n transform: TransformProperties,\n generatedTransform: string\n) => string", + "required": false, + "description": "By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate`\ncan be used to create a different order, or to append/preprend the automatically generated `transform` property.\n\n```jsx\n `rotate(${rotate}deg) translateX(${x}px)`\n }\n/>\n```" + }, + "transformValues": { + "type": "(values: V) => V", + "required": false, + "description": "Internal.\n\nThis allows values to be transformed before being animated or set as styles.\n\nFor instance, this allows custom values in Framer Library like `size` to be converted into `width` and `height`.\nIt also allows us a chance to take a value like `Color` and convert it to an animatable color string.\n\nA few structural typing changes need making before this can be a public property:\n- Allow `Target` values to be appended by user-defined types (delete `CustomStyles` - does `size` throw a type error?)\n- Extract `CustomValueType` as a separate user-defined type (delete `CustomValueType` and animate a `Color` - does this throw a type error?)." + }, + "translate": { "type": "\"yes\" | \"no\"", "required": false }, + "typeof": { "type": "string", "required": false }, + "unselectable": { "type": "\"on\" | \"off\"", "required": false }, + "variants": { + "type": "Partial>", + "required": false + }, + "viewport": { "type": "ViewportOptions", "required": false }, + "vocab": { "type": "string", "required": false }, + "whileDrag": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the drag gesture is recognised.\n\n```jsx\n\n```" + }, + "whileFocus": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the focus gesture is recognised.\n\n```jsx\n\n```" + }, + "whileHover": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the hover gesture is recognised.\n\n```jsx\n\n```" + }, + "whileInView": { + "type": "TargetAndTransition | VariantLabels", + "required": false + }, + "whileTap": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the component is pressed.\n\n```jsx\n\n```" + } + }, + "DatePickerCalendar": {}, + "DateRangePicker": { + "onChange": { + "type": "(value?: DateRangeValue | undefined) => void", + "required": true + }, + "allowsNonContiguousRanges": { + "type": "boolean", + "required": false, + "description": "When combined with `isDateUnavailable`, determines whether non-contiguous ranges,\ni.e. ranges containing unavailable dates, may be selected." + }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { + "type": "RangeValue", + "required": false, + "description": "The default value (uncontrolled)." + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "endName": { + "type": "string", + "required": false, + "description": "The name of the end date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "locale": { "type": "string", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "maxValue": { + "type": "DateValue", + "required": false, + "description": "The maximum allowed date that a user may select." + }, + "minValue": { + "type": "DateValue", + "required": false, + "description": "The minimum allowed date that a user may select." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "shouldCloseOnSelect": { + "type": "boolean | (() => boolean)", + "defaultValue": true, + "required": false, + "description": "Determines whether the date picker popover should close automatically when a date is selected." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "startName": { + "type": "string", + "required": false, + "description": "The name of the start date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "timeZone": { "type": "string", "required": false }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + }, + "validate": { + "type": "(\n value: RangeValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateRangeValue", "required": false } + }, + "DateRangePickerContainer": { + "onChange": { + "type": "(value?: DateRangeValue | undefined) => void", + "required": true + }, + "allowsNonContiguousRanges": { + "type": "boolean", + "required": false, + "description": "When combined with `isDateUnavailable`, determines whether non-contiguous ranges,\ni.e. ranges containing unavailable dates, may be selected." + }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { + "type": "RangeValue", + "required": false, + "description": "The default value (uncontrolled)." + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "endName": { + "type": "string", + "required": false, + "description": "The name of the end date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "locale": { "type": "string", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "maxValue": { + "type": "DateValue", + "required": false, + "description": "The maximum allowed date that a user may select." + }, + "minValue": { + "type": "DateValue", + "required": false, + "description": "The minimum allowed date that a user may select." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "shouldCloseOnSelect": { + "type": "boolean | (() => boolean)", + "defaultValue": true, + "required": false, + "description": "Determines whether the date picker popover should close automatically when a date is selected." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "startName": { + "type": "string", + "required": false, + "description": "The name of the start date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "timeZone": { "type": "string", "required": false }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + }, + "validate": { + "type": "(\n value: RangeValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateRangeValue", "required": false } + }, + "DateInput": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "required": false, + "description": "Whether the element should receive focus on render." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "calendarIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The icon to use in the calendar button" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { "type": "DateValue", "required": false }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (controlled)." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "locale": { "type": "string", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "maxValue": { "type": "DateValue", "required": false }, + "minValue": { "type": "DateValue", "required": false }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(value: DateValue | null) => void", + "required": false + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "portal": { + "type": "boolean | ZIndex", + "required": false, + "description": "If `true`, the `DatePickerDialog` will open in a portal.\nAlso accepts a `z-index` value that will be passed to the dialog." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "timeZone": { "type": "string", "required": false }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + }, + "validate": { + "type": "(\n value: DateValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateValue", "required": false } + }, + "DateRangeInput": { + "onChange": { + "type": "(value?: DateRangeValue | undefined) => void", + "required": true + }, + "allowsNonContiguousRanges": { + "type": "boolean", + "required": false, + "description": "When combined with `isDateUnavailable`, determines whether non-contiguous ranges,\ni.e. ranges containing unavailable dates, may be selected." + }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "calendarIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The icon to use in the calendar button" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { + "type": "RangeValue", + "required": false, + "description": "The default value (uncontrolled)." + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "endName": { + "type": "string", + "required": false, + "description": "The name of the end date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "locale": { "type": "string", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "maxValue": { + "type": "DateValue", + "required": false, + "description": "The maximum allowed date that a user may select." + }, + "minValue": { + "type": "DateValue", + "required": false, + "description": "The minimum allowed date that a user may select." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "portal": { + "type": "boolean | ZIndex", + "required": false, + "description": "If `true`, the `DatePickerDialog` will open in a portal.\nAlso accepts a `z-index` value." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "shouldCloseOnSelect": { + "type": "boolean | (() => boolean)", + "defaultValue": true, + "required": false, + "description": "Determines whether the date picker popover should close automatically when a date is selected." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "startName": { + "type": "string", + "required": false, + "description": "The name of the start date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname)." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "timeZone": { "type": "string", "required": false }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + }, + "validate": { + "type": "(\n value: RangeValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateRangeValue", "required": false } + }, + "SegmentedInput": {}, + "InputSegment": { + "isEditable": { "type": "boolean", "required": false }, + "isPlaceholder": { "type": "boolean", "required": false }, + "maxValue": { "type": "number", "required": false }, + "minValue": { "type": "number", "required": false }, + "type": { "type": "string", "required": false } + }, + "DatePickerModal": { + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "closeOnSelect": { "type": "boolean", "required": false }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "createCalendar": { + "type": "(name: string) => Calendar", + "required": false + }, + "defaultOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (uncontrolled)." + }, + "defaultValue": { "type": "DateValue", "required": false }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A description for the field. Provides a hint such as specific requirements for what to choose." + }, + "errorMessage": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((v: ValidationResult) => ReactNode)", + "required": false, + "description": "An error message for the field." + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "granularity": { + "type": "Granularity", + "required": false, + "description": "Determines the smallest unit that is displayed in the date picker. By default, this is `\"day\"` for dates, and `\"minute\"` for times." + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "hideTimeZone": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to hide the time zone abbreviation." + }, + "hourCycle": { + "type": "12 | 24", + "required": false, + "description": "Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale." + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "isDateUnavailable": { + "type": "(date: DateValue) => boolean", + "required": false, + "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input is disabled." + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "Whether the input value is invalid." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "Whether the overlay is open by default (controlled)." + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "Whether the input can be selected but not changed by the user." + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether user input is required on the input before form submission." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display as the label." + }, + "locale": { "type": "string", "required": false }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "maxValue": { "type": "DateValue", "required": false }, + "minValue": { "type": "DateValue", "required": false }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(value: DateValue | null) => void", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onOpenChange": { + "type": "(isOpen: boolean) => void", + "required": false, + "description": "Handler that is called when the overlay's open state changes." + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "onSubmit": { + "type": "(date: DateValue | null) => void", + "required": false + }, + "pageBehavior": { + "type": "PageBehavior", + "defaultValue": "visible", + "required": false, + "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration." + }, + "placeholderValue": { + "type": "DateValue", + "required": false, + "description": "A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "shouldForceLeadingZeros": { + "type": "boolean", + "required": false, + "description": "Whether to always show leading zeros in the month, day, and hour fields.\nBy default, this is determined by the user's locale." + }, + "timeZone": { "type": "string", "required": false }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + }, + "validate": { + "type": "(\n value: DateValue\n) => true | ValidationError | null | undefined", + "required": false, + "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead." + }, + "validationBehavior": { + "type": "\"aria\" | \"native\"", + "defaultValue": "'aria'", + "required": false, + "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA." + }, + "validationState": { "type": "ValidationState", "required": false }, + "value": { "type": "DateValue", "required": false } + }, + "CycleOptions": { + "round": { + "type": "boolean", + "required": false, + "description": "Whether to round the field value to the nearest interval of the amount." + } + }, + "CycleTimeOptions": { + "hourCycle": { + "type": "12 | 24", + "defaultValue": "24", + "required": false, + "description": "Whether to use 12 or 24 hour time. If 12 hour time is chosen, the resulting value\nwill remain in the same day period as the original value (e.g. if the value is AM,\nthe resulting value also be AM)." + }, + "round": { + "type": "boolean", + "required": false, + "description": "Whether to round the field value to the nearest interval of the amount." + } + } +} diff --git a/tooling/props-docs/dist/components/DatePickerContainer.json b/tooling/props-docs/dist/components/DatePickerContainer.json new file mode 100644 index 000000000..398ab30e3 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerContainer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerContainer","methods":[],"props":{"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue | null"}},"minValue":{"defaultValue":null,"description":"","name":"minValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"maxValue":{"defaultValue":null,"description":"","name":"maxValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"((value: DateValue | null) => void)"}},"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"timeZone":{"defaultValue":null,"description":"","name":"timeZone","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerDialog.json b/tooling/props-docs/dist/components/DatePickerDialog.json new file mode 100644 index 000000000..0068a7e1b --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerDialog.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerDialog","methods":[],"props":{"hideArrow":{"defaultValue":null,"description":"Hide the arrow","name":"hideArrow","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-dialog.tsx","name":"DatePickerDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-dialog.tsx","name":"DatePickerDialogProps"}],"required":false,"type":{"name":"boolean"}},"children":{"defaultValue":null,"description":"The DatePickerDialog children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-dialog.tsx","name":"DatePickerDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-dialog.tsx","name":"DatePickerDialogProps"}],"required":true,"type":{"name":"ReactNode"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","required":false,"type":{"name":"string | number | readonly string[]"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","required":false,"type":{"name":"FormEventHandler"}},"autoFocus":{"defaultValue":null,"description":"","name":"autoFocus","required":false,"type":{"name":"boolean"}},"onFocus":{"defaultValue":null,"description":"","name":"onFocus","required":false,"type":{"name":"FocusEventHandler"}},"onBlur":{"defaultValue":null,"description":"","name":"onBlur","required":false,"type":{"name":"FocusEventHandler"}},"onKeyDown":{"defaultValue":null,"description":"","name":"onKeyDown","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUp":{"defaultValue":null,"description":"","name":"onKeyUp","required":false,"type":{"name":"KeyboardEventHandler"}},"id":{"defaultValue":null,"description":"","name":"id","required":false,"type":{"name":"string"}},"slot":{"defaultValue":null,"description":"","name":"slot","required":false,"type":{"name":"string"}},"title":{"defaultValue":null,"description":"","name":"title","required":false,"type":{"name":"string"}},"variants":{"defaultValue":null,"description":"","name":"variants","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popover/dist/popover-transition.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial>"}},"defaultChecked":{"defaultValue":null,"description":"","name":"defaultChecked","required":false,"type":{"name":"boolean"}},"suppressContentEditableWarning":{"defaultValue":null,"description":"","name":"suppressContentEditableWarning","required":false,"type":{"name":"boolean"}},"suppressHydrationWarning":{"defaultValue":null,"description":"","name":"suppressHydrationWarning","required":false,"type":{"name":"boolean"}},"accessKey":{"defaultValue":null,"description":"","name":"accessKey","required":false,"type":{"name":"string"}},"className":{"defaultValue":null,"description":"","name":"className","required":false,"type":{"name":"string"}},"contentEditable":{"defaultValue":null,"description":"","name":"contentEditable","required":false,"type":{"name":"\"inherit\" | Booleanish"}},"contextMenu":{"defaultValue":null,"description":"","name":"contextMenu","required":false,"type":{"name":"string"}},"dir":{"defaultValue":null,"description":"","name":"dir","required":false,"type":{"name":"string"}},"draggable":{"defaultValue":null,"description":"","name":"draggable","required":false,"type":{"name":"Booleanish"}},"hidden":{"defaultValue":null,"description":"","name":"hidden","required":false,"type":{"name":"boolean"}},"lang":{"defaultValue":null,"description":"","name":"lang","required":false,"type":{"name":"string"}},"nonce":{"defaultValue":null,"description":"","name":"nonce","required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"","name":"placeholder","required":false,"type":{"name":"string"}},"spellCheck":{"defaultValue":null,"description":"","name":"spellCheck","required":false,"type":{"name":"Booleanish"}},"tabIndex":{"defaultValue":null,"description":"","name":"tabIndex","required":false,"type":{"name":"number"}},"translate":{"defaultValue":null,"description":"","name":"translate","required":false,"type":{"name":"\"yes\" | \"no\""}},"radioGroup":{"defaultValue":null,"description":"","name":"radioGroup","required":false,"type":{"name":"string"}},"role":{"defaultValue":null,"description":"","name":"role","required":false,"type":{"name":"AriaRole"}},"about":{"defaultValue":null,"description":"","name":"about","required":false,"type":{"name":"string"}},"content":{"defaultValue":null,"description":"","name":"content","required":false,"type":{"name":"string"}},"datatype":{"defaultValue":null,"description":"","name":"datatype","required":false,"type":{"name":"string"}},"inlist":{"defaultValue":null,"description":"","name":"inlist","required":false,"type":{"name":"any"}},"prefix":{"defaultValue":null,"description":"","name":"prefix","required":false,"type":{"name":"string"}},"property":{"defaultValue":null,"description":"","name":"property","required":false,"type":{"name":"string"}},"rel":{"defaultValue":null,"description":"","name":"rel","required":false,"type":{"name":"string"}},"resource":{"defaultValue":null,"description":"","name":"resource","required":false,"type":{"name":"string"}},"rev":{"defaultValue":null,"description":"","name":"rev","required":false,"type":{"name":"string"}},"typeof":{"defaultValue":null,"description":"","name":"typeof","required":false,"type":{"name":"string"}},"vocab":{"defaultValue":null,"description":"","name":"vocab","required":false,"type":{"name":"string"}},"autoCapitalize":{"defaultValue":null,"description":"","name":"autoCapitalize","required":false,"type":{"name":"string"}},"autoCorrect":{"defaultValue":null,"description":"","name":"autoCorrect","required":false,"type":{"name":"string"}},"autoSave":{"defaultValue":null,"description":"","name":"autoSave","required":false,"type":{"name":"string"}},"itemProp":{"defaultValue":null,"description":"","name":"itemProp","required":false,"type":{"name":"string"}},"itemScope":{"defaultValue":null,"description":"","name":"itemScope","required":false,"type":{"name":"boolean"}},"itemType":{"defaultValue":null,"description":"","name":"itemType","required":false,"type":{"name":"string"}},"itemID":{"defaultValue":null,"description":"","name":"itemID","required":false,"type":{"name":"string"}},"itemRef":{"defaultValue":null,"description":"","name":"itemRef","required":false,"type":{"name":"string"}},"results":{"defaultValue":null,"description":"","name":"results","required":false,"type":{"name":"number"}},"security":{"defaultValue":null,"description":"","name":"security","required":false,"type":{"name":"string"}},"unselectable":{"defaultValue":null,"description":"","name":"unselectable","required":false,"type":{"name":"\"on\" | \"off\""}},"inputMode":{"defaultValue":null,"description":"","name":"inputMode","required":false,"type":{"name":"\"text\" | \"none\" | \"search\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\""}},"is":{"defaultValue":null,"description":"","name":"is","required":false,"type":{"name":"string"}},"dangerouslySetInnerHTML":{"defaultValue":null,"description":"","name":"dangerouslySetInnerHTML","required":false,"type":{"name":"{ __html: string | TrustedHTML; }"}},"onCopy":{"defaultValue":null,"description":"","name":"onCopy","required":false,"type":{"name":"ClipboardEventHandler"}},"onCopyCapture":{"defaultValue":null,"description":"","name":"onCopyCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onCut":{"defaultValue":null,"description":"","name":"onCut","required":false,"type":{"name":"ClipboardEventHandler"}},"onCutCapture":{"defaultValue":null,"description":"","name":"onCutCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onPaste":{"defaultValue":null,"description":"","name":"onPaste","required":false,"type":{"name":"ClipboardEventHandler"}},"onPasteCapture":{"defaultValue":null,"description":"","name":"onPasteCapture","required":false,"type":{"name":"ClipboardEventHandler"}},"onCompositionEnd":{"defaultValue":null,"description":"","name":"onCompositionEnd","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionEndCapture":{"defaultValue":null,"description":"","name":"onCompositionEndCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStart":{"defaultValue":null,"description":"","name":"onCompositionStart","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStartCapture":{"defaultValue":null,"description":"","name":"onCompositionStartCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdate":{"defaultValue":null,"description":"","name":"onCompositionUpdate","required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdateCapture":{"defaultValue":null,"description":"","name":"onCompositionUpdateCapture","required":false,"type":{"name":"CompositionEventHandler"}},"onFocusCapture":{"defaultValue":null,"description":"","name":"onFocusCapture","required":false,"type":{"name":"FocusEventHandler"}},"onBlurCapture":{"defaultValue":null,"description":"","name":"onBlurCapture","required":false,"type":{"name":"FocusEventHandler"}},"onChangeCapture":{"defaultValue":null,"description":"","name":"onChangeCapture","required":false,"type":{"name":"FormEventHandler"}},"onBeforeInput":{"defaultValue":null,"description":"","name":"onBeforeInput","required":false,"type":{"name":"FormEventHandler"}},"onBeforeInputCapture":{"defaultValue":null,"description":"","name":"onBeforeInputCapture","required":false,"type":{"name":"FormEventHandler"}},"onInput":{"defaultValue":null,"description":"","name":"onInput","required":false,"type":{"name":"FormEventHandler"}},"onInputCapture":{"defaultValue":null,"description":"","name":"onInputCapture","required":false,"type":{"name":"FormEventHandler"}},"onReset":{"defaultValue":null,"description":"","name":"onReset","required":false,"type":{"name":"FormEventHandler"}},"onResetCapture":{"defaultValue":null,"description":"","name":"onResetCapture","required":false,"type":{"name":"FormEventHandler"}},"onSubmit":{"defaultValue":null,"description":"","name":"onSubmit","required":false,"type":{"name":"FormEventHandler"}},"onSubmitCapture":{"defaultValue":null,"description":"","name":"onSubmitCapture","required":false,"type":{"name":"FormEventHandler"}},"onInvalid":{"defaultValue":null,"description":"","name":"onInvalid","required":false,"type":{"name":"FormEventHandler"}},"onInvalidCapture":{"defaultValue":null,"description":"","name":"onInvalidCapture","required":false,"type":{"name":"FormEventHandler"}},"onLoad":{"defaultValue":null,"description":"","name":"onLoad","required":false,"type":{"name":"ReactEventHandler"}},"onLoadCapture":{"defaultValue":null,"description":"","name":"onLoadCapture","required":false,"type":{"name":"ReactEventHandler"}},"onError":{"defaultValue":null,"description":"","name":"onError","required":false,"type":{"name":"ReactEventHandler"}},"onErrorCapture":{"defaultValue":null,"description":"","name":"onErrorCapture","required":false,"type":{"name":"ReactEventHandler"}},"onKeyDownCapture":{"defaultValue":null,"description":"","name":"onKeyDownCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPress":{"defaultValue":null,"description":"","name":"onKeyPress","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPressCapture":{"defaultValue":null,"description":"","name":"onKeyPressCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUpCapture":{"defaultValue":null,"description":"","name":"onKeyUpCapture","required":false,"type":{"name":"KeyboardEventHandler"}},"onAbort":{"defaultValue":null,"description":"","name":"onAbort","required":false,"type":{"name":"ReactEventHandler"}},"onAbortCapture":{"defaultValue":null,"description":"","name":"onAbortCapture","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlay":{"defaultValue":null,"description":"","name":"onCanPlay","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayCapture":{"defaultValue":null,"description":"","name":"onCanPlayCapture","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThrough":{"defaultValue":null,"description":"","name":"onCanPlayThrough","required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThroughCapture":{"defaultValue":null,"description":"","name":"onCanPlayThroughCapture","required":false,"type":{"name":"ReactEventHandler"}},"onDurationChange":{"defaultValue":null,"description":"","name":"onDurationChange","required":false,"type":{"name":"ReactEventHandler"}},"onDurationChangeCapture":{"defaultValue":null,"description":"","name":"onDurationChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEmptied":{"defaultValue":null,"description":"","name":"onEmptied","required":false,"type":{"name":"ReactEventHandler"}},"onEmptiedCapture":{"defaultValue":null,"description":"","name":"onEmptiedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEncrypted":{"defaultValue":null,"description":"","name":"onEncrypted","required":false,"type":{"name":"ReactEventHandler"}},"onEncryptedCapture":{"defaultValue":null,"description":"","name":"onEncryptedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onEnded":{"defaultValue":null,"description":"","name":"onEnded","required":false,"type":{"name":"ReactEventHandler"}},"onEndedCapture":{"defaultValue":null,"description":"","name":"onEndedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedData":{"defaultValue":null,"description":"","name":"onLoadedData","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedDataCapture":{"defaultValue":null,"description":"","name":"onLoadedDataCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadata":{"defaultValue":null,"description":"","name":"onLoadedMetadata","required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadataCapture":{"defaultValue":null,"description":"","name":"onLoadedMetadataCapture","required":false,"type":{"name":"ReactEventHandler"}},"onLoadStart":{"defaultValue":null,"description":"","name":"onLoadStart","required":false,"type":{"name":"ReactEventHandler"}},"onLoadStartCapture":{"defaultValue":null,"description":"","name":"onLoadStartCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPause":{"defaultValue":null,"description":"","name":"onPause","required":false,"type":{"name":"ReactEventHandler"}},"onPauseCapture":{"defaultValue":null,"description":"","name":"onPauseCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPlay":{"defaultValue":null,"description":"","name":"onPlay","required":false,"type":{"name":"ReactEventHandler"}},"onPlayCapture":{"defaultValue":null,"description":"","name":"onPlayCapture","required":false,"type":{"name":"ReactEventHandler"}},"onPlaying":{"defaultValue":null,"description":"","name":"onPlaying","required":false,"type":{"name":"ReactEventHandler"}},"onPlayingCapture":{"defaultValue":null,"description":"","name":"onPlayingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onProgress":{"defaultValue":null,"description":"","name":"onProgress","required":false,"type":{"name":"ReactEventHandler"}},"onProgressCapture":{"defaultValue":null,"description":"","name":"onProgressCapture","required":false,"type":{"name":"ReactEventHandler"}},"onRateChange":{"defaultValue":null,"description":"","name":"onRateChange","required":false,"type":{"name":"ReactEventHandler"}},"onRateChangeCapture":{"defaultValue":null,"description":"","name":"onRateChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onResize":{"defaultValue":null,"description":"","name":"onResize","required":false,"type":{"name":"ReactEventHandler"}},"onResizeCapture":{"defaultValue":null,"description":"","name":"onResizeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSeeked":{"defaultValue":null,"description":"","name":"onSeeked","required":false,"type":{"name":"ReactEventHandler"}},"onSeekedCapture":{"defaultValue":null,"description":"","name":"onSeekedCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSeeking":{"defaultValue":null,"description":"","name":"onSeeking","required":false,"type":{"name":"ReactEventHandler"}},"onSeekingCapture":{"defaultValue":null,"description":"","name":"onSeekingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onStalled":{"defaultValue":null,"description":"","name":"onStalled","required":false,"type":{"name":"ReactEventHandler"}},"onStalledCapture":{"defaultValue":null,"description":"","name":"onStalledCapture","required":false,"type":{"name":"ReactEventHandler"}},"onSuspend":{"defaultValue":null,"description":"","name":"onSuspend","required":false,"type":{"name":"ReactEventHandler"}},"onSuspendCapture":{"defaultValue":null,"description":"","name":"onSuspendCapture","required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdate":{"defaultValue":null,"description":"","name":"onTimeUpdate","required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdateCapture":{"defaultValue":null,"description":"","name":"onTimeUpdateCapture","required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChange":{"defaultValue":null,"description":"","name":"onVolumeChange","required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChangeCapture":{"defaultValue":null,"description":"","name":"onVolumeChangeCapture","required":false,"type":{"name":"ReactEventHandler"}},"onWaiting":{"defaultValue":null,"description":"","name":"onWaiting","required":false,"type":{"name":"ReactEventHandler"}},"onWaitingCapture":{"defaultValue":null,"description":"","name":"onWaitingCapture","required":false,"type":{"name":"ReactEventHandler"}},"onAuxClick":{"defaultValue":null,"description":"","name":"onAuxClick","required":false,"type":{"name":"MouseEventHandler"}},"onAuxClickCapture":{"defaultValue":null,"description":"","name":"onAuxClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onClick":{"defaultValue":null,"description":"","name":"onClick","required":false,"type":{"name":"MouseEventHandler"}},"onClickCapture":{"defaultValue":null,"description":"","name":"onClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onContextMenu":{"defaultValue":null,"description":"","name":"onContextMenu","required":false,"type":{"name":"MouseEventHandler"}},"onContextMenuCapture":{"defaultValue":null,"description":"","name":"onContextMenuCapture","required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClick":{"defaultValue":null,"description":"","name":"onDoubleClick","required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClickCapture":{"defaultValue":null,"description":"","name":"onDoubleClickCapture","required":false,"type":{"name":"MouseEventHandler"}},"onDragCapture":{"defaultValue":null,"description":"","name":"onDragCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragEndCapture":{"defaultValue":null,"description":"","name":"onDragEndCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragEnter":{"defaultValue":null,"description":"","name":"onDragEnter","required":false,"type":{"name":"DragEventHandler"}},"onDragEnterCapture":{"defaultValue":null,"description":"","name":"onDragEnterCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragExit":{"defaultValue":null,"description":"","name":"onDragExit","required":false,"type":{"name":"DragEventHandler"}},"onDragExitCapture":{"defaultValue":null,"description":"","name":"onDragExitCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragLeave":{"defaultValue":null,"description":"","name":"onDragLeave","required":false,"type":{"name":"DragEventHandler"}},"onDragLeaveCapture":{"defaultValue":null,"description":"","name":"onDragLeaveCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragOver":{"defaultValue":null,"description":"","name":"onDragOver","required":false,"type":{"name":"DragEventHandler"}},"onDragOverCapture":{"defaultValue":null,"description":"","name":"onDragOverCapture","required":false,"type":{"name":"DragEventHandler"}},"onDragStartCapture":{"defaultValue":null,"description":"","name":"onDragStartCapture","required":false,"type":{"name":"DragEventHandler"}},"onDrop":{"defaultValue":null,"description":"","name":"onDrop","required":false,"type":{"name":"DragEventHandler"}},"onDropCapture":{"defaultValue":null,"description":"","name":"onDropCapture","required":false,"type":{"name":"DragEventHandler"}},"onMouseDown":{"defaultValue":null,"description":"","name":"onMouseDown","required":false,"type":{"name":"MouseEventHandler"}},"onMouseDownCapture":{"defaultValue":null,"description":"","name":"onMouseDownCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseEnter":{"defaultValue":null,"description":"","name":"onMouseEnter","required":false,"type":{"name":"MouseEventHandler"}},"onMouseLeave":{"defaultValue":null,"description":"","name":"onMouseLeave","required":false,"type":{"name":"MouseEventHandler"}},"onMouseMove":{"defaultValue":null,"description":"","name":"onMouseMove","required":false,"type":{"name":"MouseEventHandler"}},"onMouseMoveCapture":{"defaultValue":null,"description":"","name":"onMouseMoveCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOut":{"defaultValue":null,"description":"","name":"onMouseOut","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOutCapture":{"defaultValue":null,"description":"","name":"onMouseOutCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOver":{"defaultValue":null,"description":"","name":"onMouseOver","required":false,"type":{"name":"MouseEventHandler"}},"onMouseOverCapture":{"defaultValue":null,"description":"","name":"onMouseOverCapture","required":false,"type":{"name":"MouseEventHandler"}},"onMouseUp":{"defaultValue":null,"description":"","name":"onMouseUp","required":false,"type":{"name":"MouseEventHandler"}},"onMouseUpCapture":{"defaultValue":null,"description":"","name":"onMouseUpCapture","required":false,"type":{"name":"MouseEventHandler"}},"onSelect":{"defaultValue":null,"description":"","name":"onSelect","required":false,"type":{"name":"ReactEventHandler"}},"onSelectCapture":{"defaultValue":null,"description":"","name":"onSelectCapture","required":false,"type":{"name":"ReactEventHandler"}},"onTouchCancel":{"defaultValue":null,"description":"","name":"onTouchCancel","required":false,"type":{"name":"TouchEventHandler"}},"onTouchCancelCapture":{"defaultValue":null,"description":"","name":"onTouchCancelCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchEnd":{"defaultValue":null,"description":"","name":"onTouchEnd","required":false,"type":{"name":"TouchEventHandler"}},"onTouchEndCapture":{"defaultValue":null,"description":"","name":"onTouchEndCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchMove":{"defaultValue":null,"description":"","name":"onTouchMove","required":false,"type":{"name":"TouchEventHandler"}},"onTouchMoveCapture":{"defaultValue":null,"description":"","name":"onTouchMoveCapture","required":false,"type":{"name":"TouchEventHandler"}},"onTouchStart":{"defaultValue":null,"description":"","name":"onTouchStart","required":false,"type":{"name":"TouchEventHandler"}},"onTouchStartCapture":{"defaultValue":null,"description":"","name":"onTouchStartCapture","required":false,"type":{"name":"TouchEventHandler"}},"onPointerDown":{"defaultValue":null,"description":"","name":"onPointerDown","required":false,"type":{"name":"PointerEventHandler"}},"onPointerDownCapture":{"defaultValue":null,"description":"","name":"onPointerDownCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerMove":{"defaultValue":null,"description":"","name":"onPointerMove","required":false,"type":{"name":"PointerEventHandler"}},"onPointerMoveCapture":{"defaultValue":null,"description":"","name":"onPointerMoveCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerUp":{"defaultValue":null,"description":"","name":"onPointerUp","required":false,"type":{"name":"PointerEventHandler"}},"onPointerUpCapture":{"defaultValue":null,"description":"","name":"onPointerUpCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancel":{"defaultValue":null,"description":"","name":"onPointerCancel","required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancelCapture":{"defaultValue":null,"description":"","name":"onPointerCancelCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnter":{"defaultValue":null,"description":"","name":"onPointerEnter","required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnterCapture":{"defaultValue":null,"description":"","name":"onPointerEnterCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeave":{"defaultValue":null,"description":"","name":"onPointerLeave","required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeaveCapture":{"defaultValue":null,"description":"","name":"onPointerLeaveCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOver":{"defaultValue":null,"description":"","name":"onPointerOver","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOverCapture":{"defaultValue":null,"description":"","name":"onPointerOverCapture","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOut":{"defaultValue":null,"description":"","name":"onPointerOut","required":false,"type":{"name":"PointerEventHandler"}},"onPointerOutCapture":{"defaultValue":null,"description":"","name":"onPointerOutCapture","required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCapture":{"defaultValue":null,"description":"","name":"onGotPointerCapture","required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onGotPointerCaptureCapture","required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCapture":{"defaultValue":null,"description":"","name":"onLostPointerCapture","required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onLostPointerCaptureCapture","required":false,"type":{"name":"PointerEventHandler"}},"onScroll":{"defaultValue":null,"description":"","name":"onScroll","required":false,"type":{"name":"UIEventHandler"}},"onScrollCapture":{"defaultValue":null,"description":"","name":"onScrollCapture","required":false,"type":{"name":"UIEventHandler"}},"onWheel":{"defaultValue":null,"description":"","name":"onWheel","required":false,"type":{"name":"WheelEventHandler"}},"onWheelCapture":{"defaultValue":null,"description":"","name":"onWheelCapture","required":false,"type":{"name":"WheelEventHandler"}},"onAnimationStartCapture":{"defaultValue":null,"description":"","name":"onAnimationStartCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEnd":{"defaultValue":null,"description":"","name":"onAnimationEnd","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEndCapture":{"defaultValue":null,"description":"","name":"onAnimationEndCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIteration":{"defaultValue":null,"description":"","name":"onAnimationIteration","required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIterationCapture":{"defaultValue":null,"description":"","name":"onAnimationIterationCapture","required":false,"type":{"name":"AnimationEventHandler"}},"onTransitionEnd":{"defaultValue":null,"description":"","name":"onTransitionEnd","required":false,"type":{"name":"TransitionEventHandler"}},"onTransitionEndCapture":{"defaultValue":null,"description":"","name":"onTransitionEndCapture","required":false,"type":{"name":"TransitionEventHandler"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerEndTimeField.json b/tooling/props-docs/dist/components/DatePickerEndTimeField.json new file mode 100644 index 000000000..3c1ccf115 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerEndTimeField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerEndTimeField","methods":[],"props":{"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerModal.json b/tooling/props-docs/dist/components/DatePickerModal.json new file mode 100644 index 000000000..9bb597a70 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerModal.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerModal","methods":[],"props":{"onSubmit":{"defaultValue":null,"description":"","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-modal.tsx","name":"DatePickerModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker-modal.tsx","name":"DatePickerModalProps"}],"required":false,"type":{"name":"((date: DateValue | null) => void)"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}},"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue | null"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"minValue":{"defaultValue":null,"description":"","name":"minValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"maxValue":{"defaultValue":null,"description":"","name":"maxValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"((value: DateValue | null) => void)"}},"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"timeZone":{"defaultValue":null,"description":"","name":"timeZone","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerStartTimeField.json b/tooling/props-docs/dist/components/DatePickerStartTimeField.json new file mode 100644 index 000000000..092332a75 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerStartTimeField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerStartTimeField","methods":[],"props":{"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerStatic.json b/tooling/props-docs/dist/components/DatePickerStatic.json new file mode 100644 index 000000000..a2902d7ae --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerStatic.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DatePickerStatic","methods":[],"props":{"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue | null"}},"minValue":{"defaultValue":null,"description":"","name":"minValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"maxValue":{"defaultValue":null,"description":"","name":"maxValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"DateValue"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"((value: DateValue | null) => void)"}},"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"timeZone":{"defaultValue":null,"description":"","name":"timeZone","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"string"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-picker.tsx","name":"DatePickerContainerProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DatePickerTimeField.json b/tooling/props-docs/dist/components/DatePickerTimeField.json new file mode 100644 index 000000000..c55789bd0 --- /dev/null +++ b/tooling/props-docs/dist/components/DatePickerTimeField.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/date-time/date-picker-input"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"DatePickerTimeField\n\nA Date form input with Calendar popover to allow users to enter or select a date and time value.","displayName":"DatePickerTimeField","methods":[],"props":{"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DatePickerTimeFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DateRangePicker.json b/tooling/props-docs/dist/components/DateRangePicker.json new file mode 100644 index 000000000..397948841 --- /dev/null +++ b/tooling/props-docs/dist/components/DateRangePicker.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DateRangePicker","methods":[],"props":{"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"DateRangeValue"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":true,"type":{"name":"(value?: DateRangeValue | undefined) => void"}},"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"string"}},"hourCycle":{"defaultValue":null,"description":"Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.","name":"hourCycle","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"12 | 24"}},"timeZone":{"defaultValue":null,"description":"","name":"timeZone","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"string"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DateRangePickerContainer.json b/tooling/props-docs/dist/components/DateRangePickerContainer.json new file mode 100644 index 000000000..56bbe1897 --- /dev/null +++ b/tooling/props-docs/dist/components/DateRangePickerContainer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DateRangePickerContainer","methods":[],"props":{"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"DateRangeValue"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":true,"type":{"name":"(value?: DateRangeValue | undefined) => void"}},"locale":{"defaultValue":null,"description":"","name":"locale","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"string"}},"hourCycle":{"defaultValue":null,"description":"Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.","name":"hourCycle","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"12 | 24"}},"timeZone":{"defaultValue":null,"description":"","name":"timeZone","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"string"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-range-picker.tsx","name":"DateRangePickerContainerProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DateRangePickerTimeField.json b/tooling/props-docs/dist/components/DateRangePickerTimeField.json new file mode 100644 index 000000000..e57c99a3a --- /dev/null +++ b/tooling/props-docs/dist/components/DateRangePickerTimeField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"","displayName":"DateRangePickerTimeField","methods":[],"props":{"startLabel":{"defaultValue":null,"description":"","name":"startLabel","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DateRangeTimeFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DateRangeTimeFieldProps"}],"required":false,"type":{"name":"string"}},"endLabel":{"defaultValue":null,"description":"","name":"endLabel","parent":{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DateRangeTimeFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-date-picker/src/date-field.tsx","name":"DateRangeTimeFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DisplayField.json b/tooling/props-docs/dist/components/DisplayField.json new file mode 100644 index 000000000..74dd46c1a --- /dev/null +++ b/tooling/props-docs/dist/components/DisplayField.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"DisplayField","methods":[],"props":{"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":true,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/DisplayIf.json b/tooling/props-docs/dist/components/DisplayIf.json new file mode 100644 index 000000000..0e716650f --- /dev/null +++ b/tooling/props-docs/dist/components/DisplayIf.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"Conditionally render parts of a form.","displayName":"DisplayIf","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"}],"required":true,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"}],"required":false,"type":{"name":"unknown"}},"isDisabled":{"defaultValue":null,"description":"","name":"isDisabled","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"}],"required":false,"type":{"name":"boolean"}},"isExact":{"defaultValue":null,"description":"","name":"isExact","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"}],"required":false,"type":{"name":"boolean"}},"condition":{"defaultValue":{"value":"(value) => !!value"},"description":"","name":"condition","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/display-if.tsx","name":"DisplayIfProps"}],"required":false,"type":{"name":"((value: unknown, context: UseFormReturn) => boolean)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Divider.json b/tooling/props-docs/dist/components/Divider.json new file mode 100644 index 000000000..a23f8c36a --- /dev/null +++ b/tooling/props-docs/dist/components/Divider.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/divider"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Dividers are used to visually separate content in a list or group","displayName":"Divider","methods":[],"props":{"label":{"defaultValue":null,"description":"","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"DividerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"DividerProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Drawer.json b/tooling/props-docs/dist/components/Drawer.json new file mode 100644 index 000000000..f4612e64f --- /dev/null +++ b/tooling/props-docs/dist/components/Drawer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"Drawer","methods":[],"props":{"footer":{"defaultValue":null,"description":"Drawer footer content, wrapped with `DrawerFooter`","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"DrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"DrawerProps"}],"required":false,"type":{"name":"ReactNode"}},"title":{"defaultValue":null,"description":"The drawer title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":true,"type":{"name":"ReactNode"}},"children":{"defaultValue":null,"description":"The modal children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":true,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; onClose: () => void; }>"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overflow","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseDrawerProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/EmptyState.json b/tooling/props-docs/dist/components/EmptyState.json new file mode 100644 index 000000000..6dececa4b --- /dev/null +++ b/tooling/props-docs/dist/components/EmptyState.json @@ -0,0 +1,45 @@ +{ + "EmptyState": { + "actions": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "icon": { "type": "As", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "EmptyStateContainer": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + } + }, + "EmptyStateBody": { + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + } + } +} diff --git a/tooling/props-docs/dist/components/EmptyStateBody.json b/tooling/props-docs/dist/components/EmptyStateBody.json new file mode 100644 index 000000000..1cc2617a3 --- /dev/null +++ b/tooling/props-docs/dist/components/EmptyStateBody.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"EmptyStateBody","methods":[],"props":{"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"EmptyStateBodyProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"EmptyStateBodyProps"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/EmptyStateContainer.json b/tooling/props-docs/dist/components/EmptyStateContainer.json new file mode 100644 index 000000000..9fae5b3c8 --- /dev/null +++ b/tooling/props-docs/dist/components/EmptyStateContainer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"EmptyStateContainer","methods":[],"props":{"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"EmptyStateContainerProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"EmptyStateContainerProps"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ErrorBoundary.json b/tooling/props-docs/dist/components/ErrorBoundary.json new file mode 100644 index 000000000..00c472bf3 --- /dev/null +++ b/tooling/props-docs/dist/components/ErrorBoundary.json @@ -0,0 +1,16 @@ +{ + "ErrorBoundary": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "fallback": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "onError": { + "type": "(error: Error, errorInfo: ErrorInfo) => void", + "required": false + } + } +} diff --git a/tooling/props-docs/dist/components/FeatureFlags.json b/tooling/props-docs/dist/components/FeatureFlags.json new file mode 100644 index 000000000..7beb89acb --- /dev/null +++ b/tooling/props-docs/dist/components/FeatureFlags.json @@ -0,0 +1,46 @@ +{ + "Has": { + "feature": { + "type": "string | string[]", + "required": true, + "description": "One or more flags to match." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | (({ flags }: { ...; }) => ReactElement<...>)", + "required": false, + "description": "Children will be rendered when the result is valid." + }, + "exact": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Match all or some flags." + }, + "fallback": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Renders the result is invalid." + }, + "not": { + "type": "boolean", + "required": false, + "description": "Inverse matching, eg will be valid when no flags match." + }, + "value": { + "type": "any", + "required": false, + "description": "Match the supplied flags to this value.\nMatches all truthy values by default." + } + }, + "FeaturesOptions": { + "segments": { "type": "Segment[]", "required": true }, + "attr": { "type": "UserAttributes", "required": false } + }, + "FeaturesProvider": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "value": { "type": "FeaturesOptions", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/Field.json b/tooling/props-docs/dist/components/Field.json new file mode 100644 index 000000000..083a7b4c3 --- /dev/null +++ b/tooling/props-docs/dist/components/Field.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Form field component.\n\nBuild-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","displayName":"Field","methods":[],"props":{"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"\"number\" | \"select\" | \"textarea\" | \"checkbox\" | \"radio\" | \"switch\" | \"text\" | \"url\" | \"email\" | \"phone\" | \"password\" | \"pin\" | \"native-select\""}},"hideStepper":{"defaultValue":null,"description":"Hide the stepper.","name":"hideStepper","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"boolean"}},"incrementIcon":{"defaultValue":null,"description":"Render a custom increment icon.","name":"incrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}},"decrementIcon":{"defaultValue":null,"description":"Render a custom decrement icon.","name":"decrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}},"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":true,"type":{"name":"string"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit>, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef"}},"multiple":{"defaultValue":null,"description":"Enable multiple select.","name":"multiple","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"InputHTMLAttributes"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"InputHTMLAttributes"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"SelectHTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"options":{"defaultValue":null,"description":"An array of options\nIf you leave this empty the children prop will be rendered.","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NativeSelectOptions"}],"required":false,"type":{"name":"string[] | SelectOption[] | RadioOption[] | Option$1[]"}},"renderValue":{"defaultValue":null,"description":"The function used to render the value of the select field.\n@param value The value of the select field.\n@returns The rendered value.","name":"renderValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"((value: string | string[]) => ReactNode)"}},"spacing":{"defaultValue":{"value":"0.5rem\n0.5rem"},"description":"The spacing between the checkbox and its label text\nThe spacing between the switch and its label text","name":"spacing","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"},{"fileName":"saas-ui/node_modules/@chakra-ui/switch/dist/switch.d.ts","name":"SwitchProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"SystemProps[\"marginLeft\"]\nSystemProps[\"marginLeft\"]"}},"icon":{"defaultValue":{"value":"CheckboxIcon"},"description":"The checked icon to use\nThe icon element to use in the select","name":"icon","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/select/dist/select.d.ts","name":"SelectProps"}],"required":false,"type":{"name":"React.ReactElement\nReact.ReactElement"}},"iconColor":{"defaultValue":null,"description":"The color of the checkbox icon when checked or indeterminate\nThe color of the icon","name":"iconColor","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/select/dist/select.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"string"}},"iconSize":{"defaultValue":null,"description":"The size of the checkbox icon when checked or indeterminate\nThe size (width and height) of the icon","name":"iconSize","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/select/dist/select.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"string | number"}},"inputProps":{"defaultValue":null,"description":"Additional props to be forwarded to the `input` element","name":"inputProps","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/checkbox/dist/checkbox-types-a3d7c663.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"InputHTMLAttributes"}},"leftAddon":{"defaultValue":null,"description":"","name":"leftAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"rightAddon":{"defaultValue":null,"description":"","name":"rightAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"}],"required":false,"type":{"name":"ReactNode"}},"viewIcon":{"defaultValue":null,"description":"","name":"viewIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"viewOffIcon":{"defaultValue":null,"description":"","name":"viewOffIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"pinLength":{"defaultValue":null,"description":"","name":"pinLength","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"number"}},"pinType":{"defaultValue":null,"description":"","name":"pinType","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"\"number\" | \"alphanumeric\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FieldsProvider.json b/tooling/props-docs/dist/components/FieldsProvider.json new file mode 100644 index 000000000..166b5ac61 --- /dev/null +++ b/tooling/props-docs/dist/components/FieldsProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"FieldsProvider","methods":[],"props":{"value":{"defaultValue":null,"description":"","name":"value","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"Record>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FileUpload.json b/tooling/props-docs/dist/components/FileUpload.json new file mode 100644 index 000000000..024f48433 --- /dev/null +++ b/tooling/props-docs/dist/components/FileUpload.json @@ -0,0 +1,215 @@ +{ + "FileUploadOptions": { + "accept": { + "type": "string | Record", + "required": false, + "description": "The accept file types" + }, + "allowDrop": { + "type": "boolean", + "required": false, + "description": "Whether to allow drag and drop in the dropzone element" + }, + "dir": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "The document's text/writing direction." + }, + "files": { + "type": "File[]", + "required": false, + "description": "The current value of the file input" + }, + "getRootNode": { + "type": "() => Node | ShadowRoot | Document", + "required": false, + "description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron." + }, + "isDisabled": { "type": "boolean", "required": false }, + "isValidFile": { + "type": "(file: File) => boolean", + "required": false, + "description": "Function to validate a file" + }, + "locale": { + "type": "string", + "defaultValue": "en-US", + "required": false, + "description": "The current locale. Based on the BCP 47 definition." + }, + "maxFiles": { + "type": "number", + "required": false, + "description": "The maximum number of files" + }, + "maxFileSize": { + "type": "number", + "required": false, + "description": "The maximum file size in bytes" + }, + "minFileSize": { + "type": "number", + "required": false, + "description": "The minimum file size in bytes" + }, + "name": { + "type": "string", + "required": false, + "description": "The name of the underlying file input" + }, + "onFilesChange": { + "type": "(details: FileChangeDetails) => void", + "required": false, + "description": "Function called when the value changes" + } + }, + "FileUploadPreview": { + "file": { "type": "File", "required": true }, + "align": { + "type": "ResponsiveValue>", + "required": false, + "description": "How to align the image within its bounds.\nIt maps to css `object-position` property." + }, + "crossOrigin": { + "type": "\"\" | \"anonymous\" | \"use-credentials\"", + "required": false, + "description": "The key used to set the crossOrigin on the HTMLImageElement into which the image will be loaded.\nThis tells the browser to request cross-origin access when trying to download the image data." + }, + "fallback": { + "type": "ReactElement>", + "required": false, + "description": "Fallback element to show if image is loading or image fails." + }, + "fallbackSrc": { + "type": "string", + "required": false, + "description": "Fallback image `src` to show if image is loading or image fails.\n\nNote 🚨: We recommend you use a local image" + }, + "fallbackStrategy": { + "type": "FallbackStrategy", + "defaultValue": "beforeLoadOrError", + "required": false, + "description": "- beforeLoadOrError(default): loads the fallbackImage while loading the src\n- onError: loads the fallbackImage only if there is an error fetching the src" + }, + "fetchPriority": { + "type": "\"high\" | \"low\" | \"auto\"", + "required": false + }, + "fit": { + "type": "ResponsiveValue", + "required": false, + "description": "How the image to fit within its bounds.\nIt maps to css `object-fit` property." + }, + "htmlHeight": { + "type": "string | number", + "required": false, + "description": "The native HTML `height` attribute to the passed to the `img`" + }, + "htmlWidth": { + "type": "string | number", + "required": false, + "description": "The native HTML `width` attribute to the passed to the `img`" + }, + "ignoreFallback": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, opt out of the `fallbackSrc` logic and use as `img`" + }, + "loading": { "type": "\"eager\" | \"lazy\"", "required": false }, + "onError": { + "type": "ReactEventHandler", + "required": false, + "description": "A callback for when there was an error loading the image `src`" + }, + "onLoad": { + "type": "ReactEventHandler", + "required": false, + "description": "A callback for when the image `src` has been loaded" + }, + "sizes": { + "type": "string", + "required": false, + "description": "The image `sizes` attribute" + }, + "srcSet": { + "type": "string", + "required": false, + "description": "The image `srcset` attribute" + } + }, + "FileUpload": { + "accept": { + "type": "string | Record", + "required": false, + "description": "The accept file types" + }, + "allowDrop": { + "type": "boolean", + "required": false, + "description": "Whether to allow drag and drop in the dropzone element" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((props: FileUploadRenderContext) => ReactNode)", + "required": false + }, + "dir": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "The document's text/writing direction." + }, + "files": { + "type": "File[]", + "required": false, + "description": "The current value of the file input" + }, + "getRootNode": { + "type": "() => Node | ShadowRoot | Document", + "required": false, + "description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron." + }, + "inputRef": { + "type": "type ONLY_FOR_FORMAT =\n | ((instance: HTMLInputElement | null) => void)\n | RefObject", + "required": false + }, + "isDisabled": { "type": "boolean", "required": false }, + "isValidFile": { + "type": "(file: File) => boolean", + "required": false, + "description": "Function to validate a file" + }, + "locale": { + "type": "string", + "defaultValue": "en-US", + "required": false, + "description": "The current locale. Based on the BCP 47 definition." + }, + "maxFiles": { + "type": "number", + "required": false, + "description": "The maximum number of files" + }, + "maxFileSize": { + "type": "number", + "required": false, + "description": "The maximum file size in bytes" + }, + "minFileSize": { + "type": "number", + "required": false, + "description": "The minimum file size in bytes" + }, + "name": { + "type": "string", + "required": false, + "description": "The name of the underlying file input" + }, + "onFilesChange": { + "type": "(details: FileChangeDetails) => void", + "required": false, + "description": "Function called when the value changes" + } + } +} diff --git a/tooling/props-docs/dist/components/FilterIcon.json b/tooling/props-docs/dist/components/FilterIcon.json new file mode 100644 index 000000000..73cbcfd2a --- /dev/null +++ b/tooling/props-docs/dist/components/FilterIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"FilterIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Filters.json b/tooling/props-docs/dist/components/Filters.json new file mode 100644 index 000000000..811a3de02 --- /dev/null +++ b/tooling/props-docs/dist/components/Filters.json @@ -0,0 +1,1141 @@ +{ + "FilterItem": { + "id": { + "type": "string", + "required": true, + "description": "The filter id" + }, + "activeLabel": { + "type": "string", + "required": false, + "description": "The active filter label\n\ne.g. \"Contact\"" + }, + "defaultOperator": { + "type": "FilterOperatorId", + "required": false, + "description": "The default operator" + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "Icon displayed before the label" + }, + "items": { + "type": "FilterItems", + "required": false, + "description": "The available" + }, + "label": { + "type": "string", + "required": false, + "description": "The filter label\n\ne.g. \"Contact is lead\"" + }, + "multiple": { + "type": "boolean", + "required": false, + "description": "Enable multiple select if true" + }, + "operators": { + "type": "FilterOperatorId[]", + "required": false, + "description": "The available operators" + }, + "type": { + "type": "FilterType", + "required": false, + "description": "The filter type" + }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false, + "description": "The filter value" + } + }, + "FilterItems": { + "length": { + "type": "number", + "required": true, + "description": "Gets or sets the length of the array. This is a number one higher than the highest index in the array." + }, + "toLocaleString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.\n\n\nReturns a date converted to a string using the current locale." + }, + "toString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array.\n\n\nReturns a string representation of a function." + } + }, + "FilterMenu": { + "items": { "type": "FilterItems", "required": true }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "autoSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "buttonProps": { "type": "ButtonProps", "required": false }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when you click outside\nthe menu list" + }, + "closeOnSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when a menu item is\nclicked" + }, + "command": { "type": "string", "required": false }, + "computePositionOnMount": { "type": "boolean", "required": false }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "required": false, + "description": "If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "icon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "id": { "type": "string", "required": false }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "inputDefaultValue": { "type": "string", "required": false }, + "inputValue": { "type": "string", "required": false }, + "isLazy": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open." + }, + "isOpen": { "type": "boolean", "required": false }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open." + }, + "listProps": { "type": "MenuListProps", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "multiple": { "type": "boolean", "required": false }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onChange": { + "type": "(value?: FilterValue | undefined) => void", + "required": false + }, + "onClose": { "type": "() => void", "required": false }, + "onInputChange": { + "type": "(\n value: string,\n activeItemId?: string | undefined\n) => void", + "required": false + }, + "onOpen": { "type": "() => void", "required": false }, + "onSelect": { + "type": "(item: FilterItem | FilterItem[]) => Promise", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "ActiveFilterContainer": { + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + } + }, + "ActiveFilterLabel": { + "icon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false + } + }, + "ActiveFilterOperator": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "autoSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "buttonProps": { "type": "MenuButtonProps", "required": false }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when you click outside\nthe menu list" + }, + "closeOnSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when a menu item is\nclicked" + }, + "computePositionOnMount": { "type": "boolean", "required": false }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "FilterOperatorId | (() => FilterOperatorId)", + "required": false, + "description": "The initial value to be used, in uncontrolled mode" + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "required": false, + "description": "If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { "type": "string", "required": false }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isLazy": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open." + }, + "isOpen": { "type": "boolean", "required": false }, + "items": { "type": "FilterItem[]", "required": false }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "menuListProps": { "type": "MenuDialogListProps", "required": false }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onChange": { + "type": "(value: FilterOperatorId) => void", + "required": false, + "description": "The callback fired when the value changes" + }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "shouldUpdate": { + "type": "(\n prev: FilterOperatorId,\n next: FilterOperatorId\n) => boolean", + "required": false, + "description": "The function that determines if the state should be updated" + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "value": { + "type": "FilterOperatorId", + "required": false, + "description": "The value to used in controlled mode" + } + }, + "ActiveFilter": { + "id": { "type": "string", "required": true }, + "defaultOperator": { "type": "FilterOperatorId", "required": false }, + "defaultValue": { + "type": "string | number | boolean | string[] | Date", + "required": false + }, + "formatLabel": { + "type": "(label?: string | undefined) => string", + "required": false + }, + "formatValue": { + "type": "(value: FilterValue) => string", + "required": false + }, + "icon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "items": { "type": "FilterItems", "required": false }, + "label": { "type": "string", "required": false }, + "multiple": { "type": "boolean", "required": false }, + "onChange": { "type": "(filter: Filter) => void", "required": false }, + "onOperatorChange": { + "type": "(id: FilterOperatorId) => void", + "required": false + }, + "onRemove": { "type": "() => void", "required": false }, + "onValueChange": { + "type": "(value: FilterValue) => void", + "required": false + }, + "operator": { "type": "FilterOperatorId", "required": false }, + "operators": { "type": "FilterItem[]", "required": false }, + "renderValue": { "type": "FilterRenderFn", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + }, + "type": { "type": "FilterType", "required": false }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "ActiveFilterValue": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultValue": { + "type": "string | number | boolean | string[] | Date", + "required": false + }, + "format": { "type": "(value: FilterValue) => string", "required": false }, + "items": { "type": "FilterItems", "required": false }, + "multiple": { "type": "boolean", "required": false }, + "onChange": { "type": "(value: FilterValue) => void", "required": false }, + "placeholder": { "type": "string", "required": false }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "ActiveFiltersList": { + "align": { + "type": "ResponsiveValue", + "required": false, + "description": "The `align-items` value (for main axis alignment)" + }, + "direction": { + "type": "ResponsiveValue", + "required": false, + "description": "The `flex-direction` value" + }, + "formatValue": { + "type": "(value: FilterValue) => string", + "required": false + }, + "justify": { + "type": "ResponsiveValue", + "required": false, + "description": "The `justify-content` value (for cross-axis alignment)" + }, + "renderValue": { "type": "FilterRenderFn", "required": false }, + "shouldWrapChildren": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the children will be wrapped in a `WrapItem`" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The space between each child (even if it wraps)" + }, + "spacingX": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The horizontal space between the each child (even if it wraps). Defaults to `spacing` if not defined." + }, + "spacingY": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The vertical space between the each child (even if it wraps). Defaults to `spacing` if not defined." + } + }, + "ActiveFilterValueOptions": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultValue": { + "type": "string | number | boolean | string[] | Date", + "required": false + }, + "format": { "type": "(value: FilterValue) => string", "required": false }, + "items": { "type": "FilterItems", "required": false }, + "multiple": { "type": "boolean", "required": false }, + "onChange": { "type": "(value: FilterValue) => void", "required": false }, + "placeholder": { "type": "string", "required": false }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "Filter": { + "contains": { + "type": "(string: string, substring: string) => boolean", + "required": true, + "description": "Returns whether a string contains a given substring." + }, + "endsWith": { + "type": "(string: string, substring: string) => boolean", + "required": true, + "description": "Returns whether a string ends with a given substring." + }, + "startsWith": { + "type": "(string: string, substring: string) => boolean", + "required": true, + "description": "Returns whether a string starts with a given substring." + } + }, + "UseActiveFilter": { + "id": { "type": "string", "required": true }, + "defaultOperator": { "type": "FilterOperatorId", "required": false }, + "defaultValue": { + "type": "string | number | boolean | string[] | Date", + "required": false + }, + "onChange": { "type": "(filter: Filter) => void", "required": false }, + "onOperatorChange": { + "type": "(operator: FilterOperatorId) => void", + "required": false + }, + "onValueChange": { + "type": "(value: FilterValue) => void", + "required": false + }, + "operator": { "type": "FilterOperatorId", "required": false }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "UseFilterOperator": { + "defaultValue": { + "type": "FilterOperatorId | (() => FilterOperatorId)", + "required": false, + "description": "The initial value to be used, in uncontrolled mode" + }, + "items": { "type": "FilterItem[]", "required": false }, + "onChange": { + "type": "(value: FilterOperatorId) => void", + "required": false, + "description": "The callback fired when the value changes" + }, + "shouldUpdate": { + "type": "(\n prev: FilterOperatorId,\n next: FilterOperatorId\n) => boolean", + "required": false, + "description": "The function that determines if the state should be updated" + }, + "value": { + "type": "FilterOperatorId", + "required": false, + "description": "The value to used in controlled mode" + } + }, + "UseFilterValue": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultValue": { + "type": "string | number | boolean | string[] | Date", + "required": false + }, + "format": { "type": "(value: FilterValue) => string", "required": false }, + "items": { "type": "FilterItems", "required": false }, + "multiple": { "type": "boolean", "required": false }, + "onChange": { "type": "(value: FilterValue) => void", "required": false }, + "placeholder": { "type": "string", "required": false }, + "value": { + "type": "string | number | boolean | string[] | Date", + "required": false + } + }, + "FiltersProvider": { + "activeFilters": { "type": "Filter[]", "required": false }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultFilters": { "type": "Filter[]", "required": false }, + "filters": { "type": "FilterItem[]", "required": false }, + "onBeforeEnableFilter": { + "type": "(\n filter: Filter,\n filterItem?: FilterItem | undefined\n) => Promise", + "required": false + }, + "onChange": { + "type": "(activeFilters: Filter[]) => void", + "required": false + }, + "operators": { "type": "FilterOperators", "required": false } + }, + "NoFilteredResults": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "clearLabel": { "type": "string", "required": false }, + "onReset": { "type": "() => void", "required": false }, + "resource": { "type": "string", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"auto\"\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false + }, + "title": { "type": "string", "required": false } + }, + "FilterOperatorId": { + "__@iterator@382478": { + "type": "() => IterableIterator", + "required": true, + "description": "Iterator" + }, + "anchor": { + "type": "(name: string) => string", + "required": true, + "description": "Returns an `` HTML anchor element and sets the name attribute to the text value" + }, + "at": { + "type": "(index: number) => string | undefined", + "required": true, + "description": "Returns a new String consisting of the single UTF-16 code unit located at the specified index." + }, + "big": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "blink": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "bold": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "charAt": { + "type": "(pos: number) => string", + "required": true, + "description": "Returns the character at the specified index." + }, + "charCodeAt": { + "type": "(index: number) => number", + "required": true, + "description": "Returns the Unicode value of the character at the specified location." + }, + "codePointAt": { + "type": "(pos: number) => number | undefined", + "required": true, + "description": "Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point\nvalue of the UTF-16 encoded code point starting at the string element at position pos in\nthe String resulting from converting this object to a String.\nIf there is no element at that position, the result is undefined.\nIf a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos." + }, + "concat": { + "type": "(...strings: string[]) => string", + "required": true, + "description": "Returns a string that contains the concatenation of two or more strings." + }, + "endsWith": { + "type": "(\n searchString: string,\n endPosition?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nendPosition – length(this). Otherwise returns false." + }, + "fixed": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "fontcolor": { + "type": "(color: string) => string", + "required": true, + "description": "Returns a `` HTML element and sets the color attribute value" + }, + "fontsize": { + "type": "{ (size: number): string; (size: string): string }", + "required": true, + "description": "Returns a `` HTML element and sets the size attribute value" + }, + "includes": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if searchString appears as a substring of the result of converting this\nobject to a String, at one or more positions that are\ngreater than or equal to position; otherwise, returns false." + }, + "indexOf": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => number", + "required": true, + "description": "Returns the position of the first occurrence of a substring." + }, + "italics": { + "type": "() => string", + "required": true, + "description": "Returns an `` HTML element" + }, + "lastIndexOf": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => number", + "required": true, + "description": "Returns the last occurrence of a substring in the string." + }, + "length": { + "type": "number", + "required": true, + "description": "Returns the length of a String object." + }, + "link": { + "type": "(url: string) => string", + "required": true, + "description": "Returns an `` HTML element and sets the href attribute value" + }, + "localeCompare": { + "type": "{\n (that: string): number\n (\n that: string,\n locales?: string | string[] | undefined,\n options?: CollatorOptions | undefined\n ): number\n}", + "required": true, + "description": "Determines whether two strings are equivalent in the current locale.\n\n\nDetermines whether two strings are equivalent in the current or specified locale." + }, + "match": { + "type": "{\n (regexp: string | RegExp): RegExpMatchArray | null\n (matcher: {\n [Symbol.match](string: string): RegExpMatchArray | null\n }): RegExpMatchArray | null\n}", + "required": true, + "description": "Matches a string with a regular expression, and returns an array containing the results of that search.\n\n\nMatches a string or an object that supports being matched against, and returns an array\ncontaining the results of that search, or null if no matches are found." + }, + "matchAll": { + "type": "(regexp: RegExp) => IterableIterator", + "required": true, + "description": "Matches a string with a regular expression, and returns an iterable of matches\ncontaining the results of that search." + }, + "normalize": { + "type": "{\n (form: \"NFC\" | \"NFD\" | \"NFKC\" | \"NFKD\"): string\n (form?: string | undefined): string\n}", + "required": true, + "description": "Returns the String value result of normalizing the string into the normalization form\nnamed by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms." + }, + "padEnd": { + "type": "(\n maxLength: number,\n fillString?: string | undefined\n) => string", + "required": true, + "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the end (right) of the current string." + }, + "padStart": { + "type": "(\n maxLength: number,\n fillString?: string | undefined\n) => string", + "required": true, + "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the start (left) of the current string." + }, + "repeat": { + "type": "(count: number) => string", + "required": true, + "description": "Returns a String value that is made from count copies appended together. If count is 0,\nthe empty string is returned." + }, + "replace": { + "type": "{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }", + "required": true, + "description": "Replaces text in a string, using a regular expression or search string.\n\n\nPasses a string and \n{@linkcode \nreplaceValue\n}\n to the `[Symbol.replace]` method on \n{@linkcode \nsearchValue\n}\n. This method is expected to implement its own replacement algorithm.\n\n\nReplaces text in a string, using an object that supports replacement within a string." + }, + "replaceAll": { + "type": "{\n (searchValue: string | RegExp, replaceValue: string): string\n (\n searchValue: string | RegExp,\n replacer: (substring: string, ...args: any[]) => string\n ): string\n}", + "required": true, + "description": "Replace all instances of a substring in a string, using a regular expression or search string." + }, + "search": { + "type": "{\n (regexp: string | RegExp): number\n (searcher: { [Symbol.search](string: string): number }): number\n}", + "required": true, + "description": "Finds the first substring match in a regular expression search." + }, + "slice": { + "type": "(\n start?: number | undefined,\n end?: number | undefined\n) => string", + "required": true, + "description": "Returns a section of a string." + }, + "small": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "split": { + "type": "{\n (separator: string | RegExp, limit?: number | undefined): string[]\n (\n splitter: {\n [Symbol.split](string: string, limit?: number | undefined): string[]\n },\n limit?: number | undefined\n ): string[]\n}", + "required": true, + "description": "Split a string into substrings using the specified separator and return them as an array." + }, + "startsWith": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nposition. Otherwise returns false." + }, + "strike": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "sub": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "substr": { + "type": "(from: number, length?: number | undefined) => string", + "required": true, + "description": "Gets a substring beginning at the specified location and having the specified length." + }, + "substring": { + "type": "(start: number, end?: number | undefined) => string", + "required": true, + "description": "Returns the substring at the specified location within a String object." + }, + "sup": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "toLocaleLowerCase": { + "type": "(locales?: string | string[] | undefined) => string", + "required": true, + "description": "Converts all alphabetic characters to lowercase, taking into account the host environment's current locale." + }, + "toLocaleUpperCase": { + "type": "(locales?: string | string[] | undefined) => string", + "required": true, + "description": "Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale." + }, + "toLowerCase": { + "type": "() => string", + "required": true, + "description": "Converts all the alphabetic characters in a string to lowercase." + }, + "toString": { + "type": "() => string", + "required": true, + "description": "Returns a string representation of a string." + }, + "toUpperCase": { + "type": "() => string", + "required": true, + "description": "Converts all the alphabetic characters in a string to uppercase." + }, + "trim": { + "type": "() => string", + "required": true, + "description": "Removes the leading and trailing white space and line terminator characters from a string." + }, + "trimEnd": { + "type": "() => string", + "required": true, + "description": "Removes the trailing white space and line terminator characters from a string." + }, + "trimLeft": { + "type": "() => string", + "required": true, + "description": "Removes the leading white space and line terminator characters from a string." + }, + "trimRight": { + "type": "() => string", + "required": true, + "description": "Removes the trailing white space and line terminator characters from a string." + }, + "trimStart": { + "type": "() => string", + "required": true, + "description": "Removes the leading white space and line terminator characters from a string." + }, + "valueOf": { + "type": "() => string", + "required": true, + "description": "Returns the primitive value of the specified object." + } + }, + "FilterType": { + "__@iterator@382478": { + "type": "() => IterableIterator", + "required": true, + "description": "Iterator" + }, + "anchor": { + "type": "(name: string) => string", + "required": true, + "description": "Returns an `` HTML anchor element and sets the name attribute to the text value" + }, + "at": { + "type": "(index: number) => string | undefined", + "required": true, + "description": "Returns a new String consisting of the single UTF-16 code unit located at the specified index." + }, + "big": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "blink": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "bold": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "charAt": { + "type": "(pos: number) => string", + "required": true, + "description": "Returns the character at the specified index." + }, + "charCodeAt": { + "type": "(index: number) => number", + "required": true, + "description": "Returns the Unicode value of the character at the specified location." + }, + "codePointAt": { + "type": "(pos: number) => number | undefined", + "required": true, + "description": "Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point\nvalue of the UTF-16 encoded code point starting at the string element at position pos in\nthe String resulting from converting this object to a String.\nIf there is no element at that position, the result is undefined.\nIf a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos." + }, + "concat": { + "type": "(...strings: string[]) => string", + "required": true, + "description": "Returns a string that contains the concatenation of two or more strings." + }, + "endsWith": { + "type": "(\n searchString: string,\n endPosition?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nendPosition – length(this). Otherwise returns false." + }, + "fixed": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "fontcolor": { + "type": "(color: string) => string", + "required": true, + "description": "Returns a `` HTML element and sets the color attribute value" + }, + "fontsize": { + "type": "{ (size: number): string; (size: string): string }", + "required": true, + "description": "Returns a `` HTML element and sets the size attribute value" + }, + "includes": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if searchString appears as a substring of the result of converting this\nobject to a String, at one or more positions that are\ngreater than or equal to position; otherwise, returns false." + }, + "indexOf": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => number", + "required": true, + "description": "Returns the position of the first occurrence of a substring." + }, + "italics": { + "type": "() => string", + "required": true, + "description": "Returns an `` HTML element" + }, + "lastIndexOf": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => number", + "required": true, + "description": "Returns the last occurrence of a substring in the string." + }, + "length": { + "type": "number", + "required": true, + "description": "Returns the length of a String object." + }, + "link": { + "type": "(url: string) => string", + "required": true, + "description": "Returns an `` HTML element and sets the href attribute value" + }, + "localeCompare": { + "type": "{\n (that: string): number\n (\n that: string,\n locales?: string | string[] | undefined,\n options?: CollatorOptions | undefined\n ): number\n}", + "required": true, + "description": "Determines whether two strings are equivalent in the current locale.\n\n\nDetermines whether two strings are equivalent in the current or specified locale." + }, + "match": { + "type": "{\n (regexp: string | RegExp): RegExpMatchArray | null\n (matcher: {\n [Symbol.match](string: string): RegExpMatchArray | null\n }): RegExpMatchArray | null\n}", + "required": true, + "description": "Matches a string with a regular expression, and returns an array containing the results of that search.\n\n\nMatches a string or an object that supports being matched against, and returns an array\ncontaining the results of that search, or null if no matches are found." + }, + "matchAll": { + "type": "(regexp: RegExp) => IterableIterator", + "required": true, + "description": "Matches a string with a regular expression, and returns an iterable of matches\ncontaining the results of that search." + }, + "normalize": { + "type": "{\n (form: \"NFC\" | \"NFD\" | \"NFKC\" | \"NFKD\"): string\n (form?: string | undefined): string\n}", + "required": true, + "description": "Returns the String value result of normalizing the string into the normalization form\nnamed by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms." + }, + "padEnd": { + "type": "(\n maxLength: number,\n fillString?: string | undefined\n) => string", + "required": true, + "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the end (right) of the current string." + }, + "padStart": { + "type": "(\n maxLength: number,\n fillString?: string | undefined\n) => string", + "required": true, + "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the start (left) of the current string." + }, + "repeat": { + "type": "(count: number) => string", + "required": true, + "description": "Returns a String value that is made from count copies appended together. If count is 0,\nthe empty string is returned." + }, + "replace": { + "type": "{ (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }", + "required": true, + "description": "Replaces text in a string, using a regular expression or search string.\n\n\nPasses a string and \n{@linkcode \nreplaceValue\n}\n to the `[Symbol.replace]` method on \n{@linkcode \nsearchValue\n}\n. This method is expected to implement its own replacement algorithm.\n\n\nReplaces text in a string, using an object that supports replacement within a string." + }, + "replaceAll": { + "type": "{\n (searchValue: string | RegExp, replaceValue: string): string\n (\n searchValue: string | RegExp,\n replacer: (substring: string, ...args: any[]) => string\n ): string\n}", + "required": true, + "description": "Replace all instances of a substring in a string, using a regular expression or search string." + }, + "search": { + "type": "{\n (regexp: string | RegExp): number\n (searcher: { [Symbol.search](string: string): number }): number\n}", + "required": true, + "description": "Finds the first substring match in a regular expression search." + }, + "slice": { + "type": "(\n start?: number | undefined,\n end?: number | undefined\n) => string", + "required": true, + "description": "Returns a section of a string." + }, + "small": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "split": { + "type": "{\n (separator: string | RegExp, limit?: number | undefined): string[]\n (\n splitter: {\n [Symbol.split](string: string, limit?: number | undefined): string[]\n },\n limit?: number | undefined\n ): string[]\n}", + "required": true, + "description": "Split a string into substrings using the specified separator and return them as an array." + }, + "startsWith": { + "type": "(\n searchString: string,\n position?: number | undefined\n) => boolean", + "required": true, + "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nposition. Otherwise returns false." + }, + "strike": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "sub": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "substr": { + "type": "(from: number, length?: number | undefined) => string", + "required": true, + "description": "Gets a substring beginning at the specified location and having the specified length." + }, + "substring": { + "type": "(start: number, end?: number | undefined) => string", + "required": true, + "description": "Returns the substring at the specified location within a String object." + }, + "sup": { + "type": "() => string", + "required": true, + "description": "Returns a `` HTML element" + }, + "toLocaleLowerCase": { + "type": "(locales?: string | string[] | undefined) => string", + "required": true, + "description": "Converts all alphabetic characters to lowercase, taking into account the host environment's current locale." + }, + "toLocaleUpperCase": { + "type": "(locales?: string | string[] | undefined) => string", + "required": true, + "description": "Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale." + }, + "toLowerCase": { + "type": "() => string", + "required": true, + "description": "Converts all the alphabetic characters in a string to lowercase." + }, + "toString": { + "type": "() => string", + "required": true, + "description": "Returns a string representation of a string." + }, + "toUpperCase": { + "type": "() => string", + "required": true, + "description": "Converts all the alphabetic characters in a string to uppercase." + }, + "trim": { + "type": "() => string", + "required": true, + "description": "Removes the leading and trailing white space and line terminator characters from a string." + }, + "trimEnd": { + "type": "() => string", + "required": true, + "description": "Removes the trailing white space and line terminator characters from a string." + }, + "trimLeft": { + "type": "() => string", + "required": true, + "description": "Removes the leading white space and line terminator characters from a string." + }, + "trimRight": { + "type": "() => string", + "required": true, + "description": "Removes the trailing white space and line terminator characters from a string." + }, + "trimStart": { + "type": "() => string", + "required": true, + "description": "Removes the leading white space and line terminator characters from a string." + }, + "valueOf": { + "type": "() => string", + "required": true, + "description": "Returns the primitive value of the specified object." + } + } +} diff --git a/tooling/props-docs/dist/components/ForgotPasswordForm.json b/tooling/props-docs/dist/components/ForgotPasswordForm.json new file mode 100644 index 000000000..c40ec9637 --- /dev/null +++ b/tooling/props-docs/dist/components/ForgotPasswordForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"ForgotPasswordForm","methods":[],"props":{"emailLabel":{"defaultValue":{"value":"Your email address"},"description":"","name":"emailLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"}],"required":false,"type":{"name":"string"}},"helpText":{"defaultValue":null,"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"}],"required":false,"type":{"name":"string"}},"submitLabel":{"defaultValue":{"value":"Reset password"},"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"}],"required":false,"type":{"name":"string"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ForgotPasswordView.json b/tooling/props-docs/dist/components/ForgotPasswordView.json new file mode 100644 index 000000000..23f8f9469 --- /dev/null +++ b/tooling/props-docs/dist/components/ForgotPasswordView.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"ForgotPasswordView","methods":[],"props":{"renderSuccess":{"defaultValue":null,"description":"","name":"renderSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forgot-password-view.tsx","name":"ForgotPasswordViewProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forgot-password-view.tsx","name":"ForgotPasswordViewProps"}],"required":false,"type":{"name":"((data: any) => ReactElement>)"}},"action":{"defaultValue":null,"description":"The submit action, `logIn` or `signUp`","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthActionEnum"}},"type":{"defaultValue":null,"description":"The authentication type, `magiclink` or `password`","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthTypeEnum"}},"title":{"defaultValue":{"value":"Forgot password"},"description":"The form title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"submitLabel":{"defaultValue":{"value":"\"Sign in\""},"description":"Label for the submit button","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"Children are passed down to the underlying form","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"Render custom elements under the submit button","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"onSuccess":{"defaultValue":null,"description":"Callback executed after succesful login or signup","name":"onSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((data: any) => void)"}},"onError":{"defaultValue":null,"description":"Error handler if login or signup fails","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((error: Error) => void)"}},"onValidationError":{"defaultValue":null,"description":"Callback executed when there are validation errors","name":"onValidationError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((errors: FieldErrors) => void)"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}},"emailLabel":{"defaultValue":null,"description":"","name":"emailLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"}],"required":false,"type":{"name":"string"}},"helpText":{"defaultValue":null,"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/forgot-password-form.tsx","name":"ForgotPasswordFormProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Form.json b/tooling/props-docs/dist/components/Form.json new file mode 100644 index 000000000..d2d63c910 --- /dev/null +++ b/tooling/props-docs/dist/components/Form.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"Form","methods":[],"props":{"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"TSchema"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"AsyncDefaultValues | { [x: string]: any; }"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldValues"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fields":{"defaultValue":null,"description":"","name":"fields","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/types.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"(FieldOverrides> & { submit?: SubmitButtonProps; })"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/create-form.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FormDialog.json b/tooling/props-docs/dist/components/FormDialog.json new file mode 100644 index 000000000..37aeeda23 --- /dev/null +++ b/tooling/props-docs/dist/components/FormDialog.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/overlay/form-dialog"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-modals/src/index.ts","description":"Can be used to quickly request information from people without leaving the current page.","displayName":"FormDialog","methods":[],"props":{"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string | (ReactElement> & string) | (ReactFragment & string) | (ReactPortal & string)"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"{ [x: string]: any; } | AsyncDefaultValues"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldValues"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"unknown"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"","name":"fields","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"(FieldOverrides & { submit?: SubmitButtonProps; })"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FormProvider.json b/tooling/props-docs/dist/components/FormProvider.json new file mode 100644 index 000000000..7a0a756f7 --- /dev/null +++ b/tooling/props-docs/dist/components/FormProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"FormProvider","methods":[],"props":{"watch":{"defaultValue":null,"description":"","name":"watch","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormWatch"}},"getValues":{"defaultValue":null,"description":"","name":"getValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormGetValues"}},"getFieldState":{"defaultValue":null,"description":"","name":"getFieldState","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormGetFieldState"}},"setError":{"defaultValue":null,"description":"","name":"setError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormSetError"}},"clearErrors":{"defaultValue":null,"description":"","name":"clearErrors","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormClearErrors"}},"setValue":{"defaultValue":null,"description":"","name":"setValue","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormSetValue"}},"trigger":{"defaultValue":null,"description":"","name":"trigger","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormTrigger"}},"formState":{"defaultValue":null,"description":"","name":"formState","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"FormState"}},"resetField":{"defaultValue":null,"description":"","name":"resetField","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormResetField"}},"reset":{"defaultValue":null,"description":"","name":"reset","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormReset"}},"handleSubmit":{"defaultValue":null,"description":"","name":"handleSubmit","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormHandleSubmit"}},"unregister":{"defaultValue":null,"description":"","name":"unregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormUnregister"}},"control":{"defaultValue":null,"description":"","name":"control","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"Control"}},"register":{"defaultValue":null,"description":"","name":"register","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormRegister"}},"setFocus":{"defaultValue":null,"description":"","name":"setFocus","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"UseFormSetFocus"}},"fieldResolver":{"defaultValue":null,"description":"","name":"fieldResolver","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form-context.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldResolver"}},"schema":{"defaultValue":null,"description":"","name":"schema","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form-context.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"TSchema"}},"fields":{"defaultValue":null,"description":"","name":"fields","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form-context.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"{ [key: string]: unknown; }"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FormStep.json b/tooling/props-docs/dist/components/FormStep.json new file mode 100644 index 000000000..a2870aeb5 --- /dev/null +++ b/tooling/props-docs/dist/components/FormStep.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/step-form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The form step containing fields for a specific step.","displayName":"FormStep","methods":[],"props":{"onSubmit":{"defaultValue":null,"description":"","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepProps"}],"required":false,"type":{"name":"FormStepSubmitHandler"}},"name":{"defaultValue":null,"description":"The step name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"}],"required":true,"type":{"name":"string"}},"schema":{"defaultValue":null,"description":"Schema","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"}],"required":false,"type":{"name":"any"}},"resolver":{"defaultValue":null,"description":"Hook Form Resolver","name":"resolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormStepOptions"}],"required":false,"type":{"name":"any"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FormStepper.json b/tooling/props-docs/dist/components/FormStepper.json new file mode 100644 index 000000000..dcaed3efe --- /dev/null +++ b/tooling/props-docs/dist/components/FormStepper.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/step-form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Renders a stepper that displays progress above the form.","displayName":"FormStepper","methods":[],"props":{"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"stepComponent":{"defaultValue":null,"description":"","name":"stepComponent","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"}],"required":false,"type":{"name":"JSXElementConstructor"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/FormValue.json b/tooling/props-docs/dist/components/FormValue.json new file mode 100644 index 000000000..f5d49b3e3 --- /dev/null +++ b/tooling/props-docs/dist/components/FormValue.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"FormValue","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Forms.json b/tooling/props-docs/dist/components/Forms.json new file mode 100644 index 000000000..ec7ab9fa9 --- /dev/null +++ b/tooling/props-docs/dist/components/Forms.json @@ -0,0 +1,3093 @@ +{ + "DisplayField": { + "name": { + "type": "string", + "required": true, + "description": "The field name" + }, + "help": { + "type": "string", + "required": false, + "description": "Field help text" + }, + "hideLabel": { + "type": "boolean", + "required": false, + "description": "Hide the field label" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "label": { + "type": "string", + "required": false, + "description": "The label text used to inform users as to what information is\nrequested for a text field." + }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false, + "description": "React hook form rules" + }, + "value": { + "type": "string | number | string[] | readonly string[]", + "required": false, + "description": "The value of the counter. Should be less than `max` and greater than `min`\n\n\nThe value of the select field.\n\n\nThe value to be used in the checkbox input.\nThis is the value that will be returned on form submission.\n\n\nThe value of the radio to be `checked`\n(in controlled mode)\n\n\nThe value of the pin input. This is the value\nthat will be returned when the pin input is filled" + } + }, + "Fields": { + "fieldResolver": { "type": "FieldResolver", "required": false }, + "focusFirstField": { "type": "boolean", "required": false }, + "schema": { "type": "NonNullable", "required": false } + }, + "FormLayout": { + "autoColumns": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridAutoColumns`" + }, + "autoFlow": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridAutoFlow`" + }, + "autoRows": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridAutoRows`" + }, + "column": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridColumn`" + }, + "columnGap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridColumnGap`" + }, + "columns": { + "type": "ResponsiveValue", + "required": false, + "description": "The number of columns" + }, + "gap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridGap`" + }, + "minChildWidth": { + "type": "ResponsiveValue", + "required": false, + "description": "The width at which child elements will break into columns. Pass a number for pixel values or a string for any other valid CSS length." + }, + "row": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridRow`" + }, + "rowGap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridRowGap`" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The gap between the grid items" + }, + "spacingX": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The column gap between the grid items" + }, + "spacingY": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The row gap between the grid items" + }, + "templateAreas": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridTemplateAreas`" + }, + "templateColumns": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridTemplateColumns`" + }, + "templateRows": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridTemplateRows`" + } + }, + "SubmitButton": { + "disableIfInvalid": { + "type": "boolean", + "required": false, + "description": "Disable the submit button if the form is invalid.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfInvalid`" + }, + "disableIfUntouched": { + "type": "boolean", + "required": false, + "description": "Disable the submit button if the form is untouched.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfUntouched`" + }, + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "ArrayFieldButton": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "ArrayFieldContainer": { + "name": { + "type": "string", + "required": true, + "description": "The field name" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultValue": { + "type": "Record", + "required": false, + "description": "Default value for new values in the array" + }, + "help": { + "type": "string", + "required": false, + "description": "Field help text" + }, + "hideLabel": { + "type": "boolean", + "required": false, + "description": "Hide the field label" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "keyName": { + "type": "string", + "defaultValue": "id", + "required": false, + "description": "Default key name for rows, change this if your data uses a different 'id' field" + }, + "label": { + "type": "string", + "required": false, + "description": "The field label" + }, + "max": { "type": "number", "required": false }, + "min": { "type": "number", "required": false }, + "placeholder": { + "type": "string", + "required": false, + "description": "The input placeholder" + }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false, + "description": "React hook form rules" + }, + "type": { + "type": "string", + "required": false, + "description": "Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type." + } + }, + "ArrayField": { + "name": { + "type": "TName", + "required": true, + "description": "The field name" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ((props: ArrayField[]) => ReactNode)", + "required": false + }, + "defaultValue": { + "type": "Record", + "required": false, + "description": "Default value for new values in the array" + }, + "help": { + "type": "string", + "required": false, + "description": "Field help text" + }, + "hideLabel": { + "type": "boolean", + "required": false, + "description": "Hide the field label" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "keyName": { + "type": "string", + "defaultValue": "id", + "required": false, + "description": "Default key name for rows, change this if your data uses a different 'id' field" + }, + "label": { + "type": "string", + "required": false, + "description": "The field label" + }, + "max": { "type": "number", "required": false }, + "min": { "type": "number", "required": false }, + "placeholder": { + "type": "string", + "required": false, + "description": "The input placeholder" + }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false, + "description": "React hook form rules" + }, + "type": { + "type": "string", + "required": false, + "description": "Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type." + } + }, + "ArrayFieldRowFields": { + "autoColumns": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridAutoColumns`" + }, + "autoFlow": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridAutoFlow`" + }, + "autoRows": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridAutoRows`" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The fields" + }, + "column": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridColumn`" + }, + "columnGap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridColumnGap`" + }, + "columns": { + "type": "ResponsiveValue", + "required": false, + "description": "Amount of field columns" + }, + "gap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridGap`" + }, + "minChildWidth": { + "type": "ResponsiveValue", + "required": false, + "description": "The width at which child elements will break into columns. Pass a number for pixel values or a string for any other valid CSS length." + }, + "row": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridRow`" + }, + "rowGap": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Shorthand prop for `gridRowGap`" + }, + "spacing": { + "type": "ResponsiveValue", + "required": false, + "description": "Spacing between fields" + }, + "spacingX": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The column gap between the grid items" + }, + "spacingY": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "The row gap between the grid items" + }, + "templateAreas": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `gridTemplateAreas`" + }, + "templateColumns": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridTemplateColumns`" + }, + "templateRows": { + "type": "ResponsiveValue>", + "required": false, + "description": "Shorthand prop for `gridTemplateRows`" + } + }, + "ArrayFieldRows": { + "children": { + "type": "(\n fields: ArrayField[]\n) => ReactElement> | null", + "required": true + } + }, + "ArrayFieldOptions": { + "name": { + "type": "TName", + "required": true, + "description": "The field name" + }, + "defaultValue": { + "type": "Record", + "required": false, + "description": "Default value for new values in the array" + }, + "keyName": { + "type": "string", + "defaultValue": "id", + "required": false, + "description": "Default key name for rows, change this if your data uses a different 'id' field" + }, + "max": { "type": "number", "required": false }, + "min": { "type": "number", "required": false } + }, + "UseArrayFieldRow": { "index": { "type": "number", "required": true } }, + "ObjectField": { + "name": { + "type": "TName", + "required": true, + "description": "The field name" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "columns": { "type": "ResponsiveValue", "required": false }, + "help": { + "type": "string", + "required": false, + "description": "Field help text" + }, + "hideLabel": { + "type": "boolean", + "required": false, + "description": "Hide the field label" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "label": { + "type": "string", + "required": false, + "description": "The field label" + }, + "placeholder": { + "type": "string", + "required": false, + "description": "The input placeholder" + }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false, + "description": "React hook form rules" + }, + "spacing": { + "type": "ResponsiveValue", + "required": false + }, + "type": { + "type": "string", + "required": false, + "description": "Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type." + } + }, + "DisplayIf": { + "children": { + "type": "ReactElement>", + "required": true + }, + "name": { "type": "TName", "required": true }, + "condition": { + "type": "(\n value: unknown,\n context: UseFormReturn\n) => boolean", + "required": false + }, + "defaultValue": { "type": "{}", "required": false }, + "isDisabled": { "type": "boolean", "required": false }, + "isExact": { "type": "boolean", "required": false }, + "onToggle": { + "type": "(\n conditionMatched: boolean,\n context: UseFormReturn\n) => void", + "required": false + } + }, + "FormStepOptions": { + "name": { + "type": "TName", + "required": true, + "description": "The step name" + }, + "resolver": { + "type": "any", + "required": false, + "description": "Hook Form Resolver" + }, + "schema": { "type": "any", "required": false, "description": "Schema" } + }, + "FormStep": { + "name": { + "type": "TName", + "required": true, + "description": "The step name" + }, + "onSubmit": { "type": "FormStepSubmitHandler", "required": false }, + "resolver": { + "type": "any", + "required": false, + "description": "Hook Form Resolver" + }, + "schema": { "type": "any", "required": false, "description": "Schema" } + }, + "FormStepper": { + "index": { + "type": "number", + "required": false, + "description": "The current step index." + }, + "onChange": { + "type": "(index: number) => void", + "required": false, + "description": "Callback invoked when the step changes." + }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false, + "description": "The orientation of the stepper." + }, + "render": { + "type": "(\n props?: any\n) => ReactElement>", + "required": false + }, + "step": { + "type": "string | number", + "required": false, + "description": "The current step index or name." + }, + "stepperProps": { + "type": "StepperProps", + "required": false, + "description": "Props to pass to the stepper component." + } + }, + "NextButton": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "label": { "type": "string", "required": false }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + }, + "submitLabel": { "type": "string", "required": false } + }, + "StepForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: StepFormRenderContext<...>) => ReactNode)", + "required": false + }, + "context": { "type": "TContext", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "isCompleted": { "type": "boolean", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onChange\" | \"onBlur\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "step": { "type": "string | number", "required": false }, + "steps": { "type": "TSteps", "required": false }, + "values": { "type": "TFieldValues", "required": false } + }, + "StepsOptions": { + "__@iterator@39699": { + "type": "() => IterableIterator<{\n name: TName\n schema?: TSchema | undefined\n}>", + "required": true, + "description": "Iterator" + }, + "__@unscopables@41156": { + "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; ... 35 more ...; readonly [Symbol.unscopables]?: boolean | undefined; }", + "required": true, + "description": "Is an object whose properties have the value 'true'\nwhen they will be absent when used in a 'with' statement." + }, + "at": { + "type": "(\n index: number\n) => { name: TName; schema?: TSchema | undefined } | undefined", + "required": true, + "description": "Returns the item located at the specified index." + }, + "concat": { + "type": "{ (...items: ConcatArray<{ name: TName; schema?: TSchema | undefined; }>[]): { name: TName; schema?: TSchema | undefined; }[]; (...items: ({ name: TName; schema?: TSchema | undefined; } | ConcatArray<...>)[]): { ...; }[]; }", + "required": true, + "description": "Combines two or more arrays.\nThis method returns a new array without modifying any existing arrays." + }, + "copyWithin": { + "type": "(\n target: number,\n start: number,\n end?: number | undefined\n) => StepsOptions", + "required": true, + "description": "Returns the this object after copying a section of the array identified by start and end\nto the same array starting at position target" + }, + "entries": { + "type": "() => IterableIterator<\n [number, { name: TName; schema?: TSchema | undefined }]\n>", + "required": true, + "description": "Returns an iterable of key, value pairs for every entry in the array" + }, + "every": { + "type": "{ (predicate: (value: { name: TName; schema?: TSchema | undefined; }, index: number, array: { name: TName; schema?: TSchema | undefined; }[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: { ...; }, index: number, array: { ...; }[]) => unknow...", + "required": true, + "description": "Determines whether all the members of an array satisfy the specified test." + }, + "fill": { + "type": "(\n value: { name: TName; schema?: TSchema | undefined },\n start?: number | undefined,\n end?: number | undefined\n) => StepsOptions", + "required": true, + "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array" + }, + "filter": { + "type": "{ (predicate: (value: { name: TName; schema?: TSchema | undefined; }, index: number, array: { name: TName; schema?: TSchema | undefined; }[]) => value is S, thisArg?: any): S[]; (predicate: (value: { ...; }, index: number, array: { ...; }[]) => unknown, thisA...", + "required": true, + "description": "Returns the elements of an array that meet the condition specified in a callback function." + }, + "find": { + "type": "{ (predicate: (value: { name: TName; schema?: TSchema | undefined; }, index: number, obj: { name: TName; schema?: TSchema | undefined; }[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: { ...; }, index: number, obj: { ...; }[]) => unknown,...", + "required": true, + "description": "Returns the value of the first element in the array where predicate is true, and undefined\notherwise." + }, + "findIndex": { + "type": "(\n predicate: (\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n obj: { name: TName; schema?: TSchema | undefined }[]\n ) => unknown,\n thisArg?: any\n) => number", + "required": true, + "description": "Returns the index of the first element in the array where predicate is true, and -1\notherwise." + }, + "findLast": { + "type": "{ (predicate: (value: { name: TName; schema?: TSchema | undefined; }, index: number, array: { name: TName; schema?: TSchema | undefined; }[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: { ...; }, index: number, array: { ...; }[]) => unkn...", + "required": true, + "description": "Returns the value of the last element in the array where predicate is true, and undefined\notherwise." + }, + "findLastIndex": { + "type": "(\n predicate: (\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n array: { name: TName; schema?: TSchema | undefined }[]\n ) => unknown,\n thisArg?: any\n) => number", + "required": true, + "description": "Returns the index of the last element in the array where predicate is true, and -1\notherwise." + }, + "flat": { + "type": "(\n this: A,\n depth?: D | undefined\n) => FlatArray[]", + "required": true, + "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the\nspecified depth." + }, + "flatMap": { + "type": "(\n callback: (\n this: This,\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n array: { name: TName; schema?: TSchema | undefined }[]\n ) => U | readonly U[],\n thisArg?: This | undefined\n) => U[]", + "required": true, + "description": "Calls a defined callback function on each element of an array. Then, flattens the result into\na new array.\nThis is identical to a map followed by flat with depth 1." + }, + "forEach": { + "type": "(\n callbackfn: (\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n array: { name: TName; schema?: TSchema | undefined }[]\n ) => void,\n thisArg?: any\n) => void", + "required": true, + "description": "Performs the specified action for each element in an array." + }, + "includes": { + "type": "(\n searchElement: { name: TName; schema?: TSchema | undefined },\n fromIndex?: number | undefined\n) => boolean", + "required": true, + "description": "Determines whether an array includes a certain element, returning true or false as appropriate." + }, + "indexOf": { + "type": "(\n searchElement: { name: TName; schema?: TSchema | undefined },\n fromIndex?: number | undefined\n) => number", + "required": true, + "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present." + }, + "join": { + "type": "(separator?: string | undefined) => string", + "required": true, + "description": "Adds all the elements of an array into a string, separated by the specified separator string." + }, + "keys": { + "type": "() => IterableIterator", + "required": true, + "description": "Returns an iterable of keys in the array" + }, + "lastIndexOf": { + "type": "(\n searchElement: { name: TName; schema?: TSchema | undefined },\n fromIndex?: number | undefined\n) => number", + "required": true, + "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present." + }, + "length": { + "type": "number", + "required": true, + "description": "Gets or sets the length of the array. This is a number one higher than the highest index in the array." + }, + "map": { + "type": "(\n callbackfn: (\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n array: { name: TName; schema?: TSchema | undefined }[]\n ) => U,\n thisArg?: any\n) => U[]", + "required": true, + "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results." + }, + "pop": { + "type": "() =>\n | { name: TName; schema?: TSchema | undefined }\n | undefined", + "required": true, + "description": "Removes the last element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "push": { + "type": "(\n ...items: { name: TName; schema?: TSchema | undefined }[]\n) => number", + "required": true, + "description": "Appends new elements to the end of an array, and returns the new length of the array." + }, + "reduce": { + "type": "{ (callbackfn: (previousValue: { name: TName; schema?: TSchema | undefined; }, currentValue: { name: TName; schema?: TSchema | undefined; }, currentIndex: number, array: { ...; }[]) => { ...; }): { ...; }; (callbackfn: (previousValue: { ...; }, currentValue: { ...; }, currentIndex: number, array: { ...; }[]) => { .....", + "required": true, + "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reduceRight": { + "type": "{ (callbackfn: (previousValue: { name: TName; schema?: TSchema | undefined; }, currentValue: { name: TName; schema?: TSchema | undefined; }, currentIndex: number, array: { ...; }[]) => { ...; }): { ...; }; (callbackfn: (previousValue: { ...; }, currentValue: { ...; }, currentIndex: number, array: { ...; }[]) => { .....", + "required": true, + "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reverse": { + "type": "() => { name: TName; schema?: TSchema | undefined }[]", + "required": true, + "description": "Reverses the elements in an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "shift": { + "type": "() =>\n | { name: TName; schema?: TSchema | undefined }\n | undefined", + "required": true, + "description": "Removes the first element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "slice": { + "type": "(\n start?: number | undefined,\n end?: number | undefined\n) => { name: TName; schema?: TSchema | undefined }[]", + "required": true, + "description": "Returns a copy of a section of an array.\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\nFor example, -2 refers to the second to last element of the array." + }, + "some": { + "type": "(\n predicate: (\n value: { name: TName; schema?: TSchema | undefined },\n index: number,\n array: { name: TName; schema?: TSchema | undefined }[]\n ) => unknown,\n thisArg?: any\n) => boolean", + "required": true, + "description": "Determines whether the specified callback function returns true for any element of an array." + }, + "sort": { + "type": "(\n compareFn?:\n | ((\n a: { name: TName; schema?: TSchema | undefined },\n b: { name: TName; schema?: TSchema | undefined }\n ) => number)\n | undefined\n) => StepsOptions", + "required": true, + "description": "Sorts an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "splice": { + "type": "{ (start: number, deleteCount?: number | undefined): { name: TName; schema?: TSchema | undefined; }[]; (start: number, deleteCount: number, ...items: { name: TName; schema?: TSchema | undefined; }[]): { ...; }[]; }", + "required": true, + "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements." + }, + "toLocaleString": { + "type": "() => string", + "required": true, + "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods." + }, + "toReversed": { + "type": "() => { name: TName; schema?: TSchema | undefined }[]", + "required": true, + "description": "Returns a copy of an array with its elements reversed." + }, + "toSorted": { + "type": "(\n compareFn?:\n | ((\n a: { name: TName; schema?: TSchema | undefined },\n b: { name: TName; schema?: TSchema | undefined }\n ) => number)\n | undefined\n) => { name: TName; schema?: TSchema | undefined }[]", + "required": true, + "description": "Returns a copy of an array with its elements sorted." + }, + "toSpliced": { + "type": "{ (start: number, deleteCount: number, ...items: { name: TName; schema?: TSchema | undefined; }[]): { name: TName; schema?: TSchema | undefined; }[]; (start: number, deleteCount?: number | undefined): { ...; }[]; }", + "required": true, + "description": "Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.\n\n\nCopies an array and removes elements while returning the remaining elements." + }, + "toString": { + "type": "() => string", + "required": true, + "description": "Returns a string representation of an array." + }, + "unshift": { + "type": "(\n ...items: { name: TName; schema?: TSchema | undefined }[]\n) => number", + "required": true, + "description": "Inserts new elements at the start of an array, and returns the new length of the array." + }, + "values": { + "type": "() => IterableIterator<{\n name: TName\n schema?: TSchema | undefined\n}>", + "required": true, + "description": "Returns an iterable of values in the array" + }, + "with": { + "type": "(\n index: number,\n value: { name: TName; schema?: TSchema | undefined }\n) => { name: TName; schema?: TSchema | undefined }[]", + "required": true, + "description": "Copies an array, then overwrites the value at the provided index with the\ngiven value. If the index is negative, then it replaces from the end\nof the array." + } + }, + "UseFormStep": { + "name": { "type": "string", "required": true }, + "onSubmit": { + "type": "FormStepSubmitHandler", + "required": false + }, + "resolver": { "type": "any", "required": false }, + "schema": { "type": "any", "required": false } + }, + "UseStepForm": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: StepFormRenderContext<...>) => ReactNode)", + "required": false + }, + "context": { "type": "TContext", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "isCompleted": { "type": "boolean", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onChange\" | \"onBlur\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "step": { "type": "string | number", "required": false }, + "steps": { "type": "TSteps", "required": false }, + "values": { "type": "TFieldValues", "required": false } + }, + "WatchField": { + "children": { + "type": "(value: Value, form: { fieldResolver?: FieldResolver | undefined; schema?: any; fields?: { [key: string]: unknown; } | undefined; watch: UseFormWatch; ... 13 more ...; setFocus: UseFormSetFocus<...>; }) => void | ReactElement<...>", + "required": true + }, + "name": { "type": "string", "required": true }, + "defaultValue": { "type": "NonNullable", "required": false }, + "isDisabled": { "type": "boolean", "required": false }, + "isExact": { "type": "boolean", "required": false } + }, + "InputRightButton": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "NativeSelect": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the select is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the select is focused. Use color keys in `theme.colors`" + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The icon element to use in the select" + }, + "iconColor": { + "type": "string", + "required": false, + "description": "The color of the icon" + }, + "iconSize": { + "type": "string", + "required": false, + "description": "The size (width and height) of the icon" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "options": { "type": "Option[]", "required": false }, + "rootProps": { + "type": "RootProps", + "required": false, + "description": "Props to forward to the root `div` element" + } + }, + "SelectButton": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "SelectList": { + "motionProps": { + "type": "HTMLMotionProps<\"div\">", + "required": false, + "description": "The framer-motion props to animate the menu list" + }, + "rootProps": { + "type": "HTMLChakraProps<\"div\">", + "required": false, + "description": "Props for the root element that positions the menu." + } + }, + "Select": { + "name": { + "type": "string", + "required": true, + "description": "The name of the input field in a native form." + }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "autoSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when you click outside\nthe menu list" + }, + "closeOnSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when a menu item is\nclicked" + }, + "colorScheme": { + "type": "\"whiteAlpha\" | \"blackAlpha\" | \"gray\" | \"red\" | \"orange\" | \"yellow\" | \"green\" | \"teal\" | \"blue\" | \"cyan\" | \"purple\" | \"pink\" | \"linkedin\" | \"facebook\" | \"messenger\" | \"whatsapp\" | \"twitter\" | \"telegram\"", + "required": false, + "description": "The visual color appearance of the component" + }, + "computePositionOnMount": { "type": "boolean", "required": false }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | string[]", + "required": false, + "description": "The initial value of the select field." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "required": false, + "description": "If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { "type": "string", "required": false }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "If `true`, the select will be disabled." + }, + "isLazy": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open." + }, + "isOpen": { "type": "boolean", "required": false }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "multiple": { + "type": "boolean", + "required": false, + "description": "Enable multiple select." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onChange": { + "type": "(value: string | string[]) => void", + "required": false, + "description": "The callback invoked when the value of the select field changes." + }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "options": { + "type": "FieldOptions", + "required": false, + "description": "An array of options\nIf you leave this empty the children prop will be rendered." + }, + "placeholder": { + "type": "string", + "required": false, + "description": "The placeholder text when there's no value." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "renderValue": { + "type": "(value: string | string[]) => ReactNode", + "required": false, + "description": "The function used to render the value of the select field." + }, + "size": { + "defaultValue": "md", + "type": "\"lg\" | \"md\" | \"sm\" | \"xs\"", + "required": false, + "description": "The size of the Select" + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "value": { + "type": "string | string[]", + "required": false, + "description": "The value of the select field." + }, + "variant": { + "defaultValue": "outline", + "type": "\"outline\" | \"filled\" | \"flushed\" | \"unstyled\"", + "required": false, + "description": "The variant of the Select" + } + }, + "PasswordInput": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is focused. Use color keys in `theme.colors`" + }, + "htmlSize": { + "type": "number", + "required": false, + "description": "The native HTML `size` attribute to be passed to the `input`" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "leftAddon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "viewIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "viewOffIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "RadioInput": { + "options": { "type": "RadioOptions", "required": true }, + "defaultValue": { + "type": "string", + "required": false, + "description": "The value of the radio to be `checked`\ninitially (in uncontrolled mode)" + }, + "direction": { "type": "StackDirection", "required": false }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped radio inputs will be disabled" + }, + "isFocusable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true` and `isDisabled` is true, all wrapped radio inputs will remain\nfocusable but not interactive." + }, + "isNative": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, input elements will receive\n`checked` attribute instead of `isChecked`.\n\nThis assumes, you're using native radio inputs" + }, + "name": { + "type": "string", + "required": false, + "description": "The `name` attribute forwarded to each `radio` element" + }, + "onChange": { + "type": "(nextValue: string) => void", + "required": false, + "description": "Function called once a radio is checked" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "value": { + "type": "string", + "required": false, + "description": "The value of the radio to be `checked`\n(in controlled mode)" + } + }, + "RadioOptions": { + "__@iterator@39699": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Iterator" + }, + "__@unscopables@41156": { + "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; ... 35 more ...; readonly [Symbol.unscopables]?: boolean | undefined; } | { ...; }", + "required": true, + "description": "Is an object whose properties have the value 'true'\nwhen they will be absent when used in a 'with' statement." + }, + "at": { + "type": "type ONLY_FOR_FORMAT =\n | ((index: number) => string | undefined)\n | ((index: number) => RadioOption | undefined)", + "required": true, + "description": "Returns the item located at the specified index." + }, + "concat": { + "type": "{ (...items: ConcatArray[]): string[]; (...items: (string | ConcatArray)[]): string[]; } | { (...items: ConcatArray[]): RadioOption[]; (...items: (RadioOption | ConcatArray<...>)[]): RadioOption[]; }", + "required": true, + "description": "Combines two or more arrays.\nThis method returns a new array without modifying any existing arrays." + }, + "copyWithin": { + "type": "type ONLY_FOR_FORMAT =\n | ((target: number, start: number, end?: number | undefined) => string[])\n | ((target: number, start: number, end?: number | undefined) => RadioOption[])", + "required": true, + "description": "Returns the this object after copying a section of the array identified by start and end\nto the same array starting at position target" + }, + "entries": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator<[number, string]>)\n | (() => IterableIterator<[number, RadioOption]>)", + "required": true, + "description": "Returns an iterable of key, value pairs for every entry in the array" + }, + "every": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean; } | { ...; }", + "required": true, + "description": "Determines whether all the members of an array satisfy the specified test." + }, + "fill": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n value: string,\n start?: number | undefined,\n end?: number | undefined\n ) => string[])\n | ((\n value: RadioOption,\n start?: number | undefined,\n end?: number | undefined\n ) => RadioOption[])", + "required": true, + "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array" + }, + "filter": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): S[]; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[]; } | { ...; }", + "required": true, + "description": "Returns the elements of an array that meet the condition specified in a callback function." + }, + "find": { + "type": "{ (predicate: (value: string, index: number, obj: string[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string | undefined; } | { ...; }", + "required": true, + "description": "Returns the value of the first element in the array where predicate is true, and undefined\notherwise." + }, + "findIndex": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, obj: string[]) => unknown,\n thisArg?: any\n ) => number)\n | ((\n predicate: (\n value: RadioOption,\n index: number,\n obj: RadioOption[]\n ) => unknown,\n thisArg?: any\n ) => number)", + "required": true, + "description": "Returns the index of the first element in the array where predicate is true, and -1\notherwise." + }, + "findLast": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string | undefined; } | { ...; }", + "required": true, + "description": "Returns the value of the last element in the array where predicate is true, and undefined\notherwise." + }, + "findLastIndex": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, array: string[]) => unknown,\n thisArg?: any\n ) => number)\n | ((\n predicate: (\n value: RadioOption,\n index: number,\n array: RadioOption[]\n ) => unknown,\n thisArg?: any\n ) => number)", + "required": true, + "description": "Returns the index of the last element in the array where predicate is true, and -1\notherwise." + }, + "flat": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n this: A,\n depth?: D | undefined\n ) => FlatArray[])\n | ((\n this: A,\n depth?: D | undefined\n ) => FlatArray[])", + "required": true, + "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the\nspecified depth." + }, + "flatMap": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callback: (\n this: This,\n value: string,\n index: number,\n array: string[]\n ) => U | readonly U[],\n thisArg?: This | undefined\n ) => U[])\n | ((\n callback: (\n this: This,\n value: RadioOption,\n index: number,\n array: RadioOption[]\n ) => U | readonly U[],\n thisArg?: This | undefined\n ) => U[])", + "required": true, + "description": "Calls a defined callback function on each element of an array. Then, flattens the result into\na new array.\nThis is identical to a map followed by flat with depth 1." + }, + "forEach": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callbackfn: (value: string, index: number, array: string[]) => void,\n thisArg?: any\n ) => void)\n | ((\n callbackfn: (\n value: RadioOption,\n index: number,\n array: RadioOption[]\n ) => void,\n thisArg?: any\n ) => void)", + "required": true, + "description": "Performs the specified action for each element in an array." + }, + "includes": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => boolean)\n | ((searchElement: RadioOption, fromIndex?: number | undefined) => boolean)", + "required": true, + "description": "Determines whether an array includes a certain element, returning true or false as appropriate." + }, + "indexOf": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => number)\n | ((searchElement: RadioOption, fromIndex?: number | undefined) => number)", + "required": true, + "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present." + }, + "join": { + "type": "type ONLY_FOR_FORMAT =\n | ((separator?: string | undefined) => string)\n | ((separator?: string | undefined) => string)", + "required": true, + "description": "Adds all the elements of an array into a string, separated by the specified separator string." + }, + "keys": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Returns an iterable of keys in the array" + }, + "lastIndexOf": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => number)\n | ((searchElement: RadioOption, fromIndex?: number | undefined) => number)", + "required": true, + "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present." + }, + "length": { + "type": "number", + "required": true, + "description": "Gets or sets the length of the array. This is a number one higher than the highest index in the array." + }, + "map": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callbackfn: (value: string, index: number, array: string[]) => U,\n thisArg?: any\n ) => U[])\n | ((\n callbackfn: (\n value: RadioOption,\n index: number,\n array: RadioOption[]\n ) => U,\n thisArg?: any\n ) => U[])", + "required": true, + "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results." + }, + "pop": { + "type": "type ONLY_FOR_FORMAT =\n | (() => string | undefined)\n | (() => RadioOption | undefined)", + "required": true, + "description": "Removes the last element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "push": { + "type": "type ONLY_FOR_FORMAT =\n | ((...items: string[]) => number)\n | ((...items: RadioOption[]) => number)", + "required": true, + "description": "Appends new elements to the end of an array, and returns the new length of the array." + }, + "reduce": { + "type": "{ (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string; (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string; (callbackfn: (previousValue: U, currentValue: string, ...", + "required": true, + "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reduceRight": { + "type": "{ (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string; (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string; (callbackfn: (previousValue: U, currentValue: string, ...", + "required": true, + "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reverse": { + "type": "(() => string[]) | (() => RadioOption[])", + "required": true, + "description": "Reverses the elements in an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "shift": { + "type": "type ONLY_FOR_FORMAT =\n | (() => string | undefined)\n | (() => RadioOption | undefined)", + "required": true, + "description": "Removes the first element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "slice": { + "type": "type ONLY_FOR_FORMAT =\n | ((start?: number | undefined, end?: number | undefined) => string[])\n | ((start?: number | undefined, end?: number | undefined) => RadioOption[])", + "required": true, + "description": "Returns a copy of a section of an array.\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\nFor example, -2 refers to the second to last element of the array." + }, + "some": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, array: string[]) => unknown,\n thisArg?: any\n ) => boolean)\n | ((\n predicate: (\n value: RadioOption,\n index: number,\n array: RadioOption[]\n ) => unknown,\n thisArg?: any\n ) => boolean)", + "required": true, + "description": "Determines whether the specified callback function returns true for any element of an array." + }, + "sort": { + "type": "type ONLY_FOR_FORMAT =\n | ((compareFn?: ((a: string, b: string) => number) | undefined) => string[])\n | ((\n compareFn?: ((a: RadioOption, b: RadioOption) => number) | undefined\n ) => RadioOption[])", + "required": true, + "description": "Sorts an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "splice": { + "type": "type ONLY_FOR_FORMAT =\n | {\n (start: number, deleteCount?: number | undefined): string[]\n (start: number, deleteCount: number, ...items: string[]): string[]\n }\n | {\n (start: number, deleteCount?: number | undefined): RadioOption[]\n (\n start: number,\n deleteCount: number,\n ...items: RadioOption[]\n ): RadioOption[]\n }", + "required": true, + "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements." + }, + "toLocaleString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods." + }, + "toReversed": { + "type": "(() => string[]) | (() => RadioOption[])", + "required": true, + "description": "Returns a copy of an array with its elements reversed." + }, + "toSorted": { + "type": "type ONLY_FOR_FORMAT =\n | ((compareFn?: ((a: string, b: string) => number) | undefined) => string[])\n | ((\n compareFn?: ((a: RadioOption, b: RadioOption) => number) | undefined\n ) => RadioOption[])", + "required": true, + "description": "Returns a copy of an array with its elements sorted." + }, + "toSpliced": { + "type": "type ONLY_FOR_FORMAT =\n | {\n (start: number, deleteCount: number, ...items: string[]): string[]\n (start: number, deleteCount?: number | undefined): string[]\n }\n | {\n (\n start: number,\n deleteCount: number,\n ...items: RadioOption[]\n ): RadioOption[]\n (start: number, deleteCount?: number | undefined): RadioOption[]\n }", + "required": true, + "description": "Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.\n\n\nCopies an array and removes elements while returning the remaining elements." + }, + "toString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array." + }, + "unshift": { + "type": "type ONLY_FOR_FORMAT =\n | ((...items: string[]) => number)\n | ((...items: RadioOption[]) => number)", + "required": true, + "description": "Inserts new elements at the start of an array, and returns the new length of the array." + }, + "values": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Returns an iterable of values in the array" + }, + "with": { + "type": "type ONLY_FOR_FORMAT =\n | ((index: number, value: string) => string[])\n | ((index: number, value: RadioOption) => RadioOption[])", + "required": true, + "description": "Copies an array, then overwrites the value at the provided index with the\ngiven value. If the index is negative, then it replaces from the end\nof the array." + } + }, + "InputField": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is focused. Use color keys in `theme.colors`" + }, + "htmlSize": { + "type": "number", + "required": false, + "description": "The native HTML `size` attribute to be passed to the `input`" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "leftAddon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "rightAddon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "type": { "type": "string", "required": false } + }, + "NumberInputField": { + "type": { "type": "\"number\"", "required": true }, + "allowMouseWheel": { + "type": "boolean", + "required": false, + "description": "If `true`, the input's value will change based on mouse wheel" + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "clampValueOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "This controls the value update when you blur out of the input.\n- If `true` and the value is greater than `max`, the value will be reset to `max`\n- Else, the value remains the same." + }, + "decrementIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render a custom decrement icon." + }, + "defaultValue": { + "type": "string | number", + "required": false, + "description": "The initial value of the counter. Should be less than `max` and greater than `min`" + }, + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is invalid. Use color keys in `theme.colors`" + }, + "fieldProps": { + "type": "NumberInputFieldProps", + "required": false, + "description": "Props to pass to the NumberInputField component." + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is focused. Use color keys in `theme.colors`" + }, + "focusInputOnChange": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the input will be focused as you increment\nor decrement the value with the stepper" + }, + "format": { + "type": "(value: string | number) => string | number", + "required": false, + "description": "If using a custom display format, this converts the default format to the custom format." + }, + "getAriaValueText": { + "type": "(value: string | number) => string", + "required": false, + "description": "This is used to format the value so that screen readers\ncan speak out a more human-friendly value.\n\nIt is used to set the `aria-valuetext` property of the input" + }, + "hideStepper": { + "type": "boolean", + "required": false, + "description": "Hide the stepper." + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` to use for the number input field." + }, + "incrementIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Render a custom increment icon." + }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"text\"\n | \"email\"\n | \"tel\"\n | \"none\"\n | \"url\"\n | \"numeric\"\n | \"decimal\"", + "defaultValue": "decimal", + "required": false, + "description": "Hints at the type of data that might be entered by the user. It also determines\nthe type of keyboard shown to the user on mobile devices" + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the input should be disabled" + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "If `true`, the input will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "required": false, + "description": "If `true`, the input will be in readonly mode" + }, + "isRequired": { + "type": "boolean", + "required": false, + "description": "Whether the input is required" + }, + "isValidCharacter": { + "type": "(value: string) => boolean", + "required": false, + "description": "Whether the pressed key should be allowed in the input.\nThe default behavior is to allow DOM floating point characters defined by /^[Ee0-9+\\-.]$/" + }, + "keepWithinRange": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "This controls the value update behavior in general.\n\n- If `true` and you use the stepper or up/down arrow keys,\n the value will not exceed the `max` or go lower than `min`\n\n- If `false`, the value will be allowed to go out of range." + }, + "max": { + "type": "number", + "defaultValue": "Number.MAX_SAFE_INTEGER", + "required": false, + "description": "The maximum value of the counter" + }, + "min": { + "type": "number", + "defaultValue": "Number.MIN_SAFE_INTEGER", + "required": false, + "description": "The minimum value of the counter" + }, + "name": { + "type": "string", + "required": false, + "description": "The HTML `name` attribute used for forms" + }, + "onBlur": { + "type": "FocusEventHandler", + "required": false + }, + "onChange": { + "type": "(valueAsString: string, valueAsNumber: number) => void", + "required": false, + "description": "The callback fired when the value changes" + }, + "onFocus": { + "type": "FocusEventHandler", + "required": false + }, + "onInvalid": { + "type": "(\n message: ValidityState,\n value: string,\n valueAsNumber: number\n) => void", + "required": false + }, + "parse": { + "type": "(value: string) => string", + "required": false, + "description": "If using a custom display format, this converts the custom format to a format `parseFloat` understands." + }, + "pattern": { + "type": "string", + "defaultValue": "[0-9]*(.[0-9]+)?", + "required": false, + "description": "The pattern used to check the element's value against on form submission." + }, + "precision": { + "type": "number", + "required": false, + "description": "The number of decimal points used to round the value" + }, + "step": { + "type": "number", + "defaultValue": "1", + "required": false, + "description": "The step used to increment or decrement the value" + }, + "value": { + "type": "string | number", + "required": false, + "description": "The value of the counter. Should be less than `max` and greater than `min`" + } + }, + "PinField": { + "autoFocus": { + "type": "boolean", + "required": false, + "description": "If `true`, the pin input receives focus on mount" + }, + "defaultValue": { + "type": "string", + "required": false, + "description": "The default value of the pin input" + }, + "id": { + "type": "string", + "required": false, + "description": "The top-level id string that will be applied to the input fields.\nThe index of the input will be appended to this top-level id." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "If `true`, the pin input component is put in the disabled state" + }, + "isInvalid": { + "type": "boolean", + "required": false, + "description": "If `true`, the pin input component is put in the invalid state" + }, + "manageFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will move automatically to the next input once filled" + }, + "mask": { + "type": "boolean", + "required": false, + "description": "If `true`, the input's value will be masked just like `type=password`" + }, + "onChange": { + "type": "(value: string) => void", + "required": false, + "description": "Function called on input change" + }, + "onComplete": { + "type": "(value: string) => void", + "required": false, + "description": "Function called when all inputs have valid values" + }, + "otp": { + "type": "boolean", + "required": false, + "description": "If `true`, the pin input component signals to its fields that they should\nuse `autocomplete=\"one-time-code\"`." + }, + "pinLength": { "type": "number", "required": false }, + "pinType": { "type": "\"number\" | \"alphanumeric\"", "required": false }, + "placeholder": { + "type": "string", + "required": false, + "description": "The placeholder for the pin input" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "value": { + "type": "string", + "required": false, + "description": "The value of the pin input. This is the value\nthat will be returned when the pin input is filled" + } + }, + "SelectField": { + "name": { + "type": "string", + "required": true, + "description": "The name of the input field in a native form." + }, + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "autoSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "buttonProps": { "type": "SelectButtonProps", "required": false }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when you click outside\nthe menu list" + }, + "closeOnSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when a menu item is\nclicked" + }, + "computePositionOnMount": { "type": "boolean", "required": false }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | string[]", + "required": false, + "description": "The initial value of the select field." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "required": false, + "description": "If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { "type": "string", "required": false }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "If `true`, the select will be disabled." + }, + "isLazy": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open." + }, + "isOpen": { "type": "boolean", "required": false }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open." + }, + "listProps": { "type": "SelectListProps", "required": false }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "multiple": { + "type": "boolean", + "required": false, + "description": "Enable multiple select." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onChange": { + "type": "(value: string | string[]) => void", + "required": false, + "description": "The callback invoked when the value of the select field changes." + }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "options": { + "type": "FieldOptions", + "required": false, + "description": "An array of options\nIf you leave this empty the children prop will be rendered." + }, + "placeholder": { + "type": "string", + "required": false, + "description": "The placeholder text when there's no value." + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "renderValue": { + "type": "(value: string | string[]) => ReactNode", + "required": false, + "description": "The function used to render the value of the select field." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "value": { + "type": "string | string[]", + "required": false, + "description": "The value of the select field." + } + }, + "SwitchField": { + "aria-describedby": { "type": "string", "required": false }, + "aria-invalid": { "type": "true", "required": false }, + "aria-label": { + "type": "string", + "required": false, + "description": "Defines the string that labels the checkbox element." + }, + "aria-labelledby": { + "type": "string", + "required": false, + "description": "Refers to the `id` of the element that labels the checkbox element." + }, + "defaultChecked": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be initially checked." + }, + "id": { + "type": "string", + "required": false, + "description": "id assigned to input" + }, + "isChecked": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be checked.\nYou'll need to pass `onChange` to update its value (since it is now controlled)" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be disabled" + }, + "isFocusable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true` and `isDisabled` is passed, the checkbox will\nremain tabbable but not interactive" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox is marked as invalid.\nChanges style of unchecked state." + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox input is marked as required,\nand `required` attribute will be added" + }, + "name": { + "type": "string", + "required": false, + "description": "The name of the input field in a checkbox\n(Useful for form submission)." + }, + "onBlur": { + "type": "(event: FocusEvent) => void", + "required": false, + "description": "The callback invoked when the checkbox is blurred (loses focus)" + }, + "onChange": { + "type": "(event: ChangeEvent) => void", + "required": false, + "description": "The callback invoked when the checked state of the `Checkbox` changes." + }, + "onFocus": { + "type": "(event: FocusEvent) => void", + "required": false, + "description": "The callback invoked when the checkbox is focused" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "0.5rem", + "required": false, + "description": "The spacing between the switch and its label text" + }, + "tabIndex": { + "type": "number", + "required": false, + "description": "The tab-index property of the underlying input element." + }, + "value": { + "type": "string | number", + "required": false, + "description": "The value to be used in the checkbox input.\nThis is the value that will be returned on form submission." + } + }, + "TextareaField": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the textarea is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the textarea is focused. Use color keys in `theme.colors`" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + } + }, + "CheckboxField": { + "aria-describedby": { "type": "string", "required": false }, + "aria-invalid": { "type": "true", "required": false }, + "aria-label": { + "type": "string", + "required": false, + "description": "Defines the string that labels the checkbox element." + }, + "aria-labelledby": { + "type": "string", + "required": false, + "description": "Refers to the `id` of the element that labels the checkbox element." + }, + "icon": { + "type": "ReactElement>", + "defaultValue": "CheckboxIcon", + "required": false, + "description": "The checked icon to use" + }, + "iconColor": { + "type": "string", + "required": false, + "description": "The color of the checkbox icon when checked or indeterminate" + }, + "iconSize": { + "type": "string | number", + "required": false, + "description": "The size of the checkbox icon when checked or indeterminate" + }, + "id": { + "type": "string", + "required": false, + "description": "id assigned to input" + }, + "inputProps": { + "type": "InputHTMLAttributes", + "required": false, + "description": "Additional props to be forwarded to the `input` element" + }, + "isChecked": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be checked.\nYou'll need to pass `onChange` to update its value (since it is now controlled)" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be disabled" + }, + "isFocusable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true` and `isDisabled` is passed, the checkbox will\nremain tabbable but not interactive" + }, + "isIndeterminate": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be indeterminate.\nThis only affects the icon shown inside checkbox\nand does not modify the isChecked property." + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox is marked as invalid.\nChanges style of unchecked state." + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the checkbox input is marked as required,\nand `required` attribute will be added" + }, + "name": { + "type": "string", + "required": false, + "description": "The name of the input field in a checkbox\n(Useful for form submission)." + }, + "onChange": { + "type": "(event: ChangeEvent) => void", + "required": false, + "description": "The callback invoked when the checked state of the `Checkbox` changes." + }, + "onFocus": { + "type": "(event: FocusEvent) => void", + "required": false, + "description": "The callback invoked when the checkbox is focused" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "0.5rem", + "required": false, + "description": "The spacing between the checkbox and its label text" + }, + "tabIndex": { + "type": "number", + "required": false, + "description": "The tab-index property of the underlying input element." + }, + "value": { + "type": "string | number", + "required": false, + "description": "The value to be used in the checkbox input.\nThis is the value that will be returned on form submission." + } + }, + "NativeSelectField": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the select is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the select is focused. Use color keys in `theme.colors`" + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The icon element to use in the select" + }, + "iconColor": { + "type": "string", + "required": false, + "description": "The color of the icon" + }, + "iconSize": { + "type": "string", + "required": false, + "description": "The size (width and height) of the icon" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "options": { "type": "Option[]", "required": false }, + "rootProps": { + "type": "RootProps", + "required": false, + "description": "Props to forward to the root `div` element" + } + }, + "RadioField": { + "options": { "type": "RadioOptions", "required": true }, + "defaultValue": { + "type": "string", + "required": false, + "description": "The value of the radio to be `checked`\ninitially (in uncontrolled mode)" + }, + "direction": { "type": "StackDirection", "required": false }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped radio inputs will be disabled" + }, + "isFocusable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true` and `isDisabled` is true, all wrapped radio inputs will remain\nfocusable but not interactive." + }, + "isNative": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, input elements will receive\n`checked` attribute instead of `isChecked`.\n\nThis assumes, you're using native radio inputs" + }, + "name": { + "type": "string", + "required": false, + "description": "The `name` attribute forwarded to each `radio` element" + }, + "onChange": { + "type": "(nextValue: string) => void", + "required": false, + "description": "Function called once a radio is checked" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "value": { + "type": "string", + "required": false, + "description": "The value of the radio to be `checked`\n(in controlled mode)" + } + }, + "Field": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "BaseField": { + "name": { + "type": "TName | ArrayFieldPath", + "required": true, + "description": "The field name" + }, + "help": { + "type": "string", + "required": false, + "description": "Field help text" + }, + "hideLabel": { + "type": "boolean", + "required": false, + "description": "Hide the field label" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "label": { + "type": "string", + "required": false, + "description": "The field label" + }, + "placeholder": { + "type": "string", + "required": false, + "description": "The input placeholder" + }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false, + "description": "React hook form rules" + }, + "type": { + "type": "string", + "required": false, + "description": "Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type." + } + }, + "FieldOptions": { + "__@iterator@39699": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Iterator" + }, + "__@unscopables@41156": { + "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; ... 35 more ...; readonly [Symbol.unscopables]?: boolean | undefined; } | { ...; }", + "required": true, + "description": "Is an object whose properties have the value 'true'\nwhen they will be absent when used in a 'with' statement." + }, + "at": { + "type": "type ONLY_FOR_FORMAT =\n | ((index: number) => string | undefined)\n | ((index: number) => TOption | undefined)", + "required": true, + "description": "Returns the item located at the specified index." + }, + "concat": { + "type": "{ (...items: ConcatArray[]): string[]; (...items: (string | ConcatArray)[]): string[]; } | { (...items: ConcatArray[]): TOption[]; (...items: (TOption | ConcatArray<...>)[]): TOption[]; }", + "required": true, + "description": "Combines two or more arrays.\nThis method returns a new array without modifying any existing arrays." + }, + "copyWithin": { + "type": "type ONLY_FOR_FORMAT =\n | ((target: number, start: number, end?: number | undefined) => string[])\n | ((target: number, start: number, end?: number | undefined) => TOption[])", + "required": true, + "description": "Returns the this object after copying a section of the array identified by start and end\nto the same array starting at position target" + }, + "entries": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator<[number, string]>)\n | (() => IterableIterator<[number, TOption]>)", + "required": true, + "description": "Returns an iterable of key, value pairs for every entry in the array" + }, + "every": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean; } | { ...; }", + "required": true, + "description": "Determines whether all the members of an array satisfy the specified test." + }, + "fill": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n value: string,\n start?: number | undefined,\n end?: number | undefined\n ) => string[])\n | ((\n value: TOption,\n start?: number | undefined,\n end?: number | undefined\n ) => TOption[])", + "required": true, + "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array" + }, + "filter": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): S[]; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[]; } | { ...; }", + "required": true, + "description": "Returns the elements of an array that meet the condition specified in a callback function." + }, + "find": { + "type": "{ (predicate: (value: string, index: number, obj: string[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string | undefined; } | { ...; }", + "required": true, + "description": "Returns the value of the first element in the array where predicate is true, and undefined\notherwise." + }, + "findIndex": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, obj: string[]) => unknown,\n thisArg?: any\n ) => number)\n | ((\n predicate: (value: TOption, index: number, obj: TOption[]) => unknown,\n thisArg?: any\n ) => number)", + "required": true, + "description": "Returns the index of the first element in the array where predicate is true, and -1\notherwise." + }, + "findLast": { + "type": "{ (predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string | undefined; } | { ...; }", + "required": true, + "description": "Returns the value of the last element in the array where predicate is true, and undefined\notherwise." + }, + "findLastIndex": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, array: string[]) => unknown,\n thisArg?: any\n ) => number)\n | ((\n predicate: (value: TOption, index: number, array: TOption[]) => unknown,\n thisArg?: any\n ) => number)", + "required": true, + "description": "Returns the index of the last element in the array where predicate is true, and -1\notherwise." + }, + "flat": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n this: A,\n depth?: D | undefined\n ) => FlatArray[])\n | ((\n this: A,\n depth?: D | undefined\n ) => FlatArray[])", + "required": true, + "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the\nspecified depth." + }, + "flatMap": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callback: (\n this: This,\n value: string,\n index: number,\n array: string[]\n ) => U | readonly U[],\n thisArg?: This | undefined\n ) => U[])\n | ((\n callback: (\n this: This,\n value: TOption,\n index: number,\n array: TOption[]\n ) => U | readonly U[],\n thisArg?: This | undefined\n ) => U[])", + "required": true, + "description": "Calls a defined callback function on each element of an array. Then, flattens the result into\na new array.\nThis is identical to a map followed by flat with depth 1." + }, + "forEach": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callbackfn: (value: string, index: number, array: string[]) => void,\n thisArg?: any\n ) => void)\n | ((\n callbackfn: (value: TOption, index: number, array: TOption[]) => void,\n thisArg?: any\n ) => void)", + "required": true, + "description": "Performs the specified action for each element in an array." + }, + "includes": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => boolean)\n | ((searchElement: TOption, fromIndex?: number | undefined) => boolean)", + "required": true, + "description": "Determines whether an array includes a certain element, returning true or false as appropriate." + }, + "indexOf": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => number)\n | ((searchElement: TOption, fromIndex?: number | undefined) => number)", + "required": true, + "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present." + }, + "join": { + "type": "type ONLY_FOR_FORMAT =\n | ((separator?: string | undefined) => string)\n | ((separator?: string | undefined) => string)", + "required": true, + "description": "Adds all the elements of an array into a string, separated by the specified separator string." + }, + "keys": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Returns an iterable of keys in the array" + }, + "lastIndexOf": { + "type": "type ONLY_FOR_FORMAT =\n | ((searchElement: string, fromIndex?: number | undefined) => number)\n | ((searchElement: TOption, fromIndex?: number | undefined) => number)", + "required": true, + "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present." + }, + "length": { + "type": "number", + "required": true, + "description": "Gets or sets the length of the array. This is a number one higher than the highest index in the array." + }, + "map": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n callbackfn: (value: string, index: number, array: string[]) => U,\n thisArg?: any\n ) => U[])\n | ((\n callbackfn: (value: TOption, index: number, array: TOption[]) => U,\n thisArg?: any\n ) => U[])", + "required": true, + "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results." + }, + "pop": { + "type": "(() => string | undefined) | (() => TOption | undefined)", + "required": true, + "description": "Removes the last element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "push": { + "type": "type ONLY_FOR_FORMAT =\n | ((...items: string[]) => number)\n | ((...items: TOption[]) => number)", + "required": true, + "description": "Appends new elements to the end of an array, and returns the new length of the array." + }, + "reduce": { + "type": "{ (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string; (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string; (callbackfn: (previousValue: U, currentValue: string, ...", + "required": true, + "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reduceRight": { + "type": "{ (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string; (callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string; (callbackfn: (previousValue: U, currentValue: string, ...", + "required": true, + "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." + }, + "reverse": { + "type": "(() => string[]) | (() => TOption[])", + "required": true, + "description": "Reverses the elements in an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "shift": { + "type": "(() => string | undefined) | (() => TOption | undefined)", + "required": true, + "description": "Removes the first element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." + }, + "slice": { + "type": "type ONLY_FOR_FORMAT =\n | ((start?: number | undefined, end?: number | undefined) => string[])\n | ((start?: number | undefined, end?: number | undefined) => TOption[])", + "required": true, + "description": "Returns a copy of a section of an array.\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\nFor example, -2 refers to the second to last element of the array." + }, + "some": { + "type": "type ONLY_FOR_FORMAT =\n | ((\n predicate: (value: string, index: number, array: string[]) => unknown,\n thisArg?: any\n ) => boolean)\n | ((\n predicate: (value: TOption, index: number, array: TOption[]) => unknown,\n thisArg?: any\n ) => boolean)", + "required": true, + "description": "Determines whether the specified callback function returns true for any element of an array." + }, + "sort": { + "type": "type ONLY_FOR_FORMAT =\n | ((compareFn?: ((a: string, b: string) => number) | undefined) => string[])\n | ((\n compareFn?: ((a: TOption, b: TOption) => number) | undefined\n ) => TOption[])", + "required": true, + "description": "Sorts an array in place.\nThis method mutates the array and returns a reference to the same array." + }, + "splice": { + "type": "type ONLY_FOR_FORMAT =\n | {\n (start: number, deleteCount?: number | undefined): string[]\n (start: number, deleteCount: number, ...items: string[]): string[]\n }\n | {\n (start: number, deleteCount?: number | undefined): TOption[]\n (start: number, deleteCount: number, ...items: TOption[]): TOption[]\n }", + "required": true, + "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements." + }, + "toLocaleString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods." + }, + "toReversed": { + "type": "(() => string[]) | (() => TOption[])", + "required": true, + "description": "Returns a copy of an array with its elements reversed." + }, + "toSorted": { + "type": "type ONLY_FOR_FORMAT =\n | ((compareFn?: ((a: string, b: string) => number) | undefined) => string[])\n | ((\n compareFn?: ((a: TOption, b: TOption) => number) | undefined\n ) => TOption[])", + "required": true, + "description": "Returns a copy of an array with its elements sorted." + }, + "toSpliced": { + "type": "type ONLY_FOR_FORMAT =\n | {\n (start: number, deleteCount: number, ...items: string[]): string[]\n (start: number, deleteCount?: number | undefined): string[]\n }\n | {\n (start: number, deleteCount: number, ...items: TOption[]): TOption[]\n (start: number, deleteCount?: number | undefined): TOption[]\n }", + "required": true, + "description": "Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.\n\n\nCopies an array and removes elements while returning the remaining elements." + }, + "toString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of an array." + }, + "unshift": { + "type": "type ONLY_FOR_FORMAT =\n | ((...items: string[]) => number)\n | ((...items: TOption[]) => number)", + "required": true, + "description": "Inserts new elements at the start of an array, and returns the new length of the array." + }, + "values": { + "type": "type ONLY_FOR_FORMAT =\n | (() => IterableIterator)\n | (() => IterableIterator)", + "required": true, + "description": "Returns an iterable of values in the array" + }, + "with": { + "type": "type ONLY_FOR_FORMAT =\n | ((index: number, value: string) => string[])\n | ((index: number, value: TOption) => TOption[])", + "required": true, + "description": "Copies an array, then overwrites the value at the provided index with the\ngiven value. If the index is negative, then it replaces from the end\nof the array." + } + }, + "CreateForm": { + "fieldResolver": { "type": "GetFieldResolver", "required": false }, + "fields": { + "type": "FieldDefs extends Record>\n ? FieldDefs\n : never", + "required": false + }, + "resolver": { "type": "GetResolver", "required": false } + }, + "CreateFieldOptions": { + "BaseField": { "type": "FC", "required": false }, + "hideLabel": { "type": "boolean", "required": false }, + "isControlled": { "type": "boolean", "required": false } + }, + "Form": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: FormRenderContext<...>) => ReactNode)", + "required": false, + "description": "The form children, can be a render prop or a ReactNode." + }, + "context": { "type": "TContext", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "The field resolver, used to resolve the fields from schemas." + }, + "fields": { + "type": "DefaultFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onChange\" | \"onBlur\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "NonNullable", + "required": false, + "description": "The form schema." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "values": { "type": "TFieldValues", "required": false } + }, + "CreateStepForm": { + "fieldResolver": { "type": "GetFieldResolver", "required": false }, + "fields": { + "type": "FieldDefs extends Record>\n ? FieldDefs\n : never", + "required": false + }, + "resolver": { "type": "GetResolver", "required": false } + }, + "Controller": { + "name": { "type": "TName", "required": true }, + "render": { + "type": "({ field, fieldState, formState, }: { field: ControllerRenderProps; fieldState: ControllerFieldState; formState: UseFormStateReturn; }) => ReactElement<...>", + "required": true + }, + "control": { "type": "Control", "required": false }, + "defaultValue": { + "type": "NonNullable>", + "required": false + }, + "disabled": { "type": "boolean", "required": false }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false + }, + "shouldUnregister": { "type": "boolean", "required": false } + }, + "ControllerRender": { + "name": { "type": "TName", "required": true }, + "onBlur": { "type": "Noop", "required": true }, + "onChange": { "type": "(...event: any[]) => void", "required": true }, + "ref": { "type": "RefCallBack", "required": true }, + "disabled": { "type": "boolean", "required": false }, + "value": { + "type": "NonNullable>", + "required": false + } + }, + "FieldArrayMethod": { + "focusIndex": { "type": "number", "required": false }, + "focusName": { "type": "string", "required": false }, + "shouldFocus": { "type": "boolean", "required": false } + }, + "FormProvider": { + "clearErrors": { + "type": "UseFormClearErrors", + "required": true + }, + "control": { "type": "Control", "required": true }, + "formState": { "type": "FormState", "required": true }, + "getFieldState": { + "type": "UseFormGetFieldState", + "required": true + }, + "getValues": { "type": "UseFormGetValues", "required": true }, + "handleSubmit": { + "type": "UseFormHandleSubmit", + "required": true + }, + "register": { "type": "UseFormRegister", "required": true }, + "reset": { "type": "UseFormReset", "required": true }, + "resetField": { + "type": "UseFormResetField", + "required": true + }, + "setError": { "type": "UseFormSetError", "required": true }, + "setFocus": { "type": "UseFormSetFocus", "required": true }, + "setValue": { "type": "UseFormSetValue", "required": true }, + "trigger": { "type": "UseFormTrigger", "required": true }, + "unregister": { + "type": "UseFormUnregister", + "required": true + }, + "watch": { "type": "UseFormWatch", "required": true }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ReactNode[]", + "required": false + }, + "fieldResolver": { "type": "FieldResolver", "required": false }, + "fields": { "type": "{ [key: string]: unknown }", "required": false }, + "schema": { "type": "NonNullable", "required": false } + }, + "KeepStateOptions": { + "keepDefaultValues": { "type": "boolean", "required": false }, + "keepDirty": { "type": "boolean", "required": false }, + "keepDirtyValues": { "type": "boolean", "required": false }, + "keepErrors": { "type": "boolean", "required": false }, + "keepIsSubmitted": { "type": "boolean", "required": false }, + "keepIsValid": { "type": "boolean", "required": false }, + "keepSubmitCount": { "type": "boolean", "required": false }, + "keepTouched": { "type": "boolean", "required": false }, + "keepValues": { "type": "boolean", "required": false } + }, + "RegisterOptions": { + "deps": { "type": "string | string[]", "required": false }, + "disabled": { "type": "boolean", "required": false }, + "max": { "type": "ValidationRule", "required": false }, + "maxLength": { "type": "ValidationRule", "required": false }, + "min": { "type": "ValidationRule", "required": false }, + "minLength": { "type": "ValidationRule", "required": false }, + "onBlur": { "type": "(event: any) => void", "required": false }, + "onChange": { "type": "(event: any) => void", "required": false }, + "pattern": { "type": "ValidationRule", "required": false }, + "required": { + "type": "string | ValidationRule", + "required": false + }, + "setValueAs": { "type": "(value: any) => any", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "validate": { + "type": "type ONLY_FOR_FORMAT =\n | Validate, TFieldValues>\n | Record<\n string,\n Validate, TFieldValues>\n >", + "required": false + }, + "value": { + "type": "NonNullable>", + "required": false + }, + "valueAsDate": { "type": "boolean", "required": false }, + "valueAsNumber": { "type": "boolean", "required": false } + }, + "ResolverOptions": { + "fields": { + "type": "Record<\n string,\n {\n ref: Ref\n name: string\n refs?: HTMLInputElement[] | undefined\n mount?: boolean | undefined\n } & RegisterOptions\n>", + "required": true + }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "names": { "type": "FieldName[]", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false } + }, + "UseController": { + "name": { "type": "TName", "required": true }, + "control": { "type": "Control", "required": false }, + "defaultValue": { + "type": "NonNullable>", + "required": false + }, + "disabled": { "type": "boolean", "required": false }, + "rules": { + "type": "Omit<\n RegisterOptions,\n \"disabled\" | \"setValueAs\" | \"valueAsDate\" | \"valueAsNumber\"\n>", + "required": false + }, + "shouldUnregister": { "type": "boolean", "required": false } + }, + "UseFieldArray": { + "name": { "type": "TFieldArrayName", "required": true }, + "control": { "type": "Control", "required": false }, + "keyName": { "type": "TKeyName", "required": false }, + "rules": { + "type": "{ validate?: Validate[], TFieldValues> | Record[], TFieldValues>> | undefined; } & Pick<...>", + "required": false + }, + "shouldUnregister": { "type": "boolean", "required": false } + }, + "UseForm": { + "context": { "type": "NonNullable", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "progressive": { "type": "boolean", "required": false }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "reValidateMode": { + "type": "\"onChange\" | \"onBlur\" | \"onSubmit\"", + "required": false + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "values": { "type": "TFieldValues", "required": false } + }, + "UseFormState": { + "control": { "type": "Control", "required": false }, + "disabled": { "type": "boolean", "required": false }, + "exact": { "type": "boolean", "required": false }, + "name": { + "type": "type ONLY_FOR_FORMAT =\n | FieldPath\n | FieldPath[]\n | readonly FieldPath[]", + "required": false + } + }, + "UseWatch": { + "control": { "type": "Control", "required": false }, + "defaultValue": { "type": "{}", "required": false }, + "disabled": { "type": "boolean", "required": false }, + "exact": { "type": "boolean", "required": false }, + "name": { + "type": "type ONLY_FOR_FORMAT =\n | FieldPath\n | FieldPath[]\n | readonly FieldPath[]", + "required": false + } + } +} diff --git a/tooling/props-docs/dist/components/HamburgerIcon.json b/tooling/props-docs/dist/components/HamburgerIcon.json new file mode 100644 index 000000000..f1f2244bb --- /dev/null +++ b/tooling/props-docs/dist/components/HamburgerIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"HamburgerIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Hooks.json b/tooling/props-docs/dist/components/Hooks.json new file mode 100644 index 000000000..8150b3bfc --- /dev/null +++ b/tooling/props-docs/dist/components/Hooks.json @@ -0,0 +1,9 @@ +{ + "UseSearchQueryOptions": { + "defaultValue": { "type": "string", "required": false }, + "fields": { "type": "string[]", "required": false }, + "items": { "type": "T[]", "required": false }, + "onChange": { "type": "(value: string) => void", "required": false }, + "value": { "type": "string", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/Hotkeys.json b/tooling/props-docs/dist/components/Hotkeys.json new file mode 100644 index 000000000..f64921288 --- /dev/null +++ b/tooling/props-docs/dist/components/Hotkeys.json @@ -0,0 +1,69 @@ +{ + "HotkeysProvider": { + "hotkeys": { "type": "HotkeysConfig", "required": true }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "UseHotkeysOptions": { + "enableOnContentEditable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to enable hotkeys when the target is a content editable element." + }, + "ignoreTags": { + "type": "string[]", + "defaultValue": "['INPUT', 'TEXTAREA', 'SELECT']", + "required": false, + "description": "Ignore hotkeys when the target is an input element." + }, + "preventDefault": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether to prevent the default behavior of the event.\nEg. to override browser hotkeys." + }, + "targetElement": { + "type": "HTMLElement", + "defaultValue": "window", + "required": false, + "description": "The element to attach the event listener to." + } + }, + "HotkeysGroupListOptions": {}, + "HotkeysGroupOptions": { + "hotkeys": { + "type": "HotkeysGroupListOptions", + "required": true, + "description": "Hotkeys in this group" + }, + "title": { + "type": "string", + "required": false, + "description": "The group title" + } + }, + "HotkeysGroup": { "title": { "type": "string", "required": false } }, + "HotkeysItemOptions": { + "command": { + "type": "string", + "required": true, + "description": "The key combination.\nSupports shorthands: ⌥ ⇧ ⌃ ⌘\n\nShifted keys like ? and + are handled automatically" + }, + "label": { + "type": "string", + "required": true, + "description": "Label describing the function of this keyboard shortcut" + } + }, + "HotkeysItem": { "command": { "type": "string", "required": true } }, + "HotkeysListOptions": {}, + "HotkeysList": { + "hotkeys": { "type": "HotkeysListOptions", "required": true } + }, + "HotkeysOptions": { + "hotkeys": { "type": "HotkeysListOptions", "required": true } + } +} diff --git a/tooling/props-docs/dist/components/HotkeysGroup.json b/tooling/props-docs/dist/components/HotkeysGroup.json new file mode 100644 index 000000000..846575755 --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysGroup.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"HotkeysGroup","methods":[],"props":{"title":{"defaultValue":null,"description":"","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-hotkeys/dist/index.d.ts","name":"HotkeysGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-hotkeys/dist/index.d.ts","name":"HotkeysGroupProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/HotkeysItem.json b/tooling/props-docs/dist/components/HotkeysItem.json new file mode 100644 index 000000000..142392dd9 --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysItem.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"HotkeysItem","methods":[],"props":{"command":{"defaultValue":null,"description":"","name":"command","parent":{"fileName":"saas-ui/packages/saas-ui-hotkeys/dist/index.d.ts","name":"HotkeysItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-hotkeys/dist/index.d.ts","name":"HotkeysItemProps"}],"required":true,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/HotkeysList.json b/tooling/props-docs/dist/components/HotkeysList.json new file mode 100644 index 000000000..a1ac1c920 --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysList.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-hotkeys/src/index.ts","description":"","displayName":"HotkeysList","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"hotkeys":{"defaultValue":null,"description":"","name":"hotkeys","parent":{"fileName":"saas-ui/packages/saas-ui-hotkeys/src/hotkeys.tsx","name":"HotkeysOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-hotkeys/src/hotkeys.tsx","name":"HotkeysOptions"}],"required":true,"type":{"name":"HotkeysListOptions"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/HotkeysListItems.json b/tooling/props-docs/dist/components/HotkeysListItems.json new file mode 100644 index 000000000..db6deb5eb --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysListItems.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-hotkeys/src/index.ts","description":"","displayName":"HotkeysListItems","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/HotkeysProvider.json b/tooling/props-docs/dist/components/HotkeysProvider.json new file mode 100644 index 000000000..eb4a3a24e --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-hotkeys/src/index.ts","description":"","displayName":"HotkeysProvider","methods":[],"props":{"hotkeys":{"defaultValue":null,"description":"","name":"hotkeys","parent":{"fileName":"saas-ui/packages/saas-ui-hotkeys/src/hotkeys.tsx","name":"HotkeysOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-hotkeys/src/hotkeys.tsx","name":"HotkeysOptions"}],"required":true,"type":{"name":"HotkeysListOptions"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/HotkeysSearch.json b/tooling/props-docs/dist/components/HotkeysSearch.json new file mode 100644 index 000000000..5c08c11ce --- /dev/null +++ b/tooling/props-docs/dist/components/HotkeysSearch.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-hotkeys/src/index.ts","description":"","displayName":"HotkeysSearch","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"placeholder":{"defaultValue":{"value":"Search"},"description":"The placeholder text for the input","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"}],"required":false,"type":{"name":"string"}},"onReset":{"defaultValue":null,"description":"Callback to trigger when the reset button is clicked or escape key is pressed","name":"onReset","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"}],"required":false,"type":{"name":"(() => void)"}},"icon":{"defaultValue":null,"description":"The icon to render before the input text","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"}],"required":false,"type":{"name":"React.ReactElement"}},"resetIcon":{"defaultValue":null,"description":"The icon to render in the reset button","name":"resetIcon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"}],"required":false,"type":{"name":"React.ReactElement"}},"rightElement":{"defaultValue":null,"description":"Right element rendered when the value is empty","name":"rightElement","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SearchInputProps"}],"required":false,"type":{"name":"React.ReactElement"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/IconBadge.json b/tooling/props-docs/dist/components/IconBadge.json new file mode 100644 index 000000000..4486d4a46 --- /dev/null +++ b/tooling/props-docs/dist/components/IconBadge.json @@ -0,0 +1,21 @@ +{ + "IconBadge": { + "aria-label": { + "type": "string", + "required": false, + "description": "A11y: A label that describes the icon" + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The icon to be used in the button." + }, + "isRound": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the badge will be perfectly round. Else, it'll be slightly round" + }, + "orientation": { "type": "Orientation", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/InputField.json b/tooling/props-docs/dist/components/InputField.json new file mode 100644 index 000000000..172e6216e --- /dev/null +++ b/tooling/props-docs/dist/components/InputField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"InputField","methods":[],"props":{"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"leftAddon":{"defaultValue":null,"description":"","name":"leftAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"}],"required":false,"type":{"name":"ReactNode"}},"rightAddon":{"defaultValue":null,"description":"","name":"rightAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"InputFieldProps"}],"required":false,"type":{"name":"ReactNode"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/InputRightButton.json b/tooling/props-docs/dist/components/InputRightButton.json new file mode 100644 index 000000000..5753bff68 --- /dev/null +++ b/tooling/props-docs/dist/components/InputRightButton.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"InputRightButton","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Kanban.json b/tooling/props-docs/dist/components/Kanban.json new file mode 100644 index 000000000..dafe8c913 --- /dev/null +++ b/tooling/props-docs/dist/components/Kanban.json @@ -0,0 +1,207 @@ +{ + "Kanban": { + "asChild": { + "type": "boolean", + "required": false, + "description": "Render as a different element type." + }, + "cancelDrop": { "type": "CancelDrop", "required": false }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false + }, + "coordinateGetter": { + "type": "KeyboardCoordinateGetter", + "required": false + }, + "defaultItems": { "type": "KanbanItems", "required": false }, + "isSortable": { "type": "boolean", "required": false }, + "items": { "type": "KanbanItems", "required": false }, + "modifiers": { "type": "Modifiers", "required": false }, + "onCardDragEnd": { "type": "OnCardDragEndHandler", "required": false }, + "onChange": { "type": "(items: KanbanItems) => void", "required": false }, + "onColumnDragEnd": { "type": "OnColumnDragEndHandler", "required": false }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "strategy": { "type": "SortingStrategy", "required": false } + }, + "KanbanColumn": { + "id": { "type": "UniqueIdentifier", "required": true }, + "asChild": { + "type": "boolean", + "required": false, + "description": "Render as a different element type." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "columns": { "type": "number", "required": false }, + "isDisabled": { "type": "boolean", "required": false }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + } + }, + "KanbanColumnDragHandle": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "KanbanCard": { + "id": { "type": "UniqueIdentifier", "required": true }, + "asChild": { + "type": "boolean", + "required": false, + "description": "Render as a different element type." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "isDisabled": { "type": "boolean", "required": false } + }, + "KanbanAction": { + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"end\" | \"start\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + } + }, + "KanbanDragOverlay": { + "adjustScale": { "type": "boolean", "required": false }, + "appendToParentPortal": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the portal will check if it is within a parent portal\nand append itself to the parent's portal node.\nThis provides nesting for portals.\n\nIf `false`, the portal will always append to `document.body`\nregardless of nesting. It is used to opt out of portal nesting." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "className": { "type": "string", "required": false }, + "containerRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` to the component where the portal will be attached to." + }, + "dropAnimation": { "type": "DropAnimation", "required": false }, + "modifiers": { "type": "Modifiers", "required": false }, + "style": { "type": "CSSProperties", "required": false }, + "transition": { "type": "string | TransitionGetter", "required": false }, + "wrapperElement": { "type": "keyof IntrinsicElements", "required": false }, + "zIndex": { "type": "number", "required": false } + }, + "KanbanItems": {}, + "UseKanbanContainer": { + "cancelDrop": { "type": "CancelDrop", "required": false }, + "coordinateGetter": { + "type": "KeyboardCoordinateGetter", + "required": false + }, + "defaultItems": { "type": "KanbanItems", "required": false }, + "items": { "type": "KanbanItems", "required": false }, + "modifiers": { "type": "Modifiers", "required": false }, + "onCardDragEnd": { "type": "OnCardDragEndHandler", "required": false }, + "onChange": { "type": "(items: KanbanItems) => void", "required": false }, + "onColumnDragEnd": { "type": "OnColumnDragEndHandler", "required": false }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "strategy": { "type": "SortingStrategy", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/LineChart.json b/tooling/props-docs/dist/components/LineChart.json new file mode 100644 index 000000000..8b9b124f6 --- /dev/null +++ b/tooling/props-docs/dist/components/LineChart.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-charts/src/index.ts","description":"","displayName":"LineChart","methods":[],"props":{"data":{"defaultValue":null,"description":"","name":"data","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":true,"type":{"name":"ChartData[]"}},"showGrid":{"defaultValue":null,"description":"","name":"showGrid","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"boolean"}},"strokeWidth":{"defaultValue":null,"description":"","name":"strokeWidth","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"string"}},"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"string"}},"gradientOpacity":{"defaultValue":null,"description":"","name":"gradientOpacity","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"number"}},"tickFormatter":{"defaultValue":null,"description":"","name":"tickFormatter","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"((value: number) => string)"}},"variant":{"defaultValue":null,"description":"","name":"variant","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"\"line\" | \"solid\" | \"gradient\""}},"tooltipContent":{"defaultValue":null,"description":"","name":"tooltipContent","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"((props: TooltipProps) => ReactNode)"}},"tooltipFormatter":{"defaultValue":null,"description":"","name":"tooltipFormatter","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/line-chart.tsx","name":"LineChartProps"}],"required":false,"type":{"name":"((value: string, name: string, props: any) => string)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Link.json b/tooling/props-docs/dist/components/Link.json new file mode 100644 index 000000000..1fa3090c3 --- /dev/null +++ b/tooling/props-docs/dist/components/Link.json @@ -0,0 +1,9 @@ +{ + "Link": { + "to": { "type": "string", "required": true }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + } +} diff --git a/tooling/props-docs/dist/components/LoadingOverlay.json b/tooling/props-docs/dist/components/LoadingOverlay.json new file mode 100644 index 000000000..b58742d66 --- /dev/null +++ b/tooling/props-docs/dist/components/LoadingOverlay.json @@ -0,0 +1,54 @@ +{ + "LoadingOverlay": { + "isLoading": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Show or hide the LoadingOverlay." + }, + "motionPreset": { + "type": "\"none\" | \"fade\"", + "defaultValue": "fade", + "required": false, + "description": "The transition that should be used for the overlay" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "Spacing between children" + }, + "variant": { "type": "Variants", "defaultValue": "fill", "required": false } + }, + "LoadingText": {}, + "LoadingSpinner": { + "color": { + "type": "string", + "required": false, + "description": "The color of the spinner" + }, + "emptyColor": { + "type": "string", + "defaultValue": "transparent", + "required": false, + "description": "The color of the empty area in the spinner" + }, + "label": { + "type": "string", + "defaultValue": "Loading...", + "required": false, + "description": "For accessibility, it is important to add a fallback loading text.\nThis text will be visible to screen readers." + }, + "speed": { + "type": "string", + "defaultValue": "0.45s", + "required": false, + "description": "The speed of the spinner." + }, + "thickness": { + "type": "string", + "defaultValue": "2px", + "required": false, + "description": "The thickness of the spinner" + } + } +} diff --git a/tooling/props-docs/dist/components/LoginButton.json b/tooling/props-docs/dist/components/LoginButton.json new file mode 100644 index 000000000..2ab7f3d8e --- /dev/null +++ b/tooling/props-docs/dist/components/LoginButton.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"LoginButton","methods":[],"props":{"disableIfUntouched":{"defaultValue":null,"description":"Disable the submit button if the form is untouched.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfUntouched`","name":"disableIfUntouched","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SubmitButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SubmitButtonProps"}],"required":false,"type":{"name":"boolean"}},"disableIfInvalid":{"defaultValue":null,"description":"Disable the submit button if the form is invalid.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfInvalid`","name":"disableIfInvalid","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SubmitButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SubmitButtonProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/LoginView.json b/tooling/props-docs/dist/components/LoginView.json new file mode 100644 index 000000000..81bb24c9f --- /dev/null +++ b/tooling/props-docs/dist/components/LoginView.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"LoginView","methods":[],"props":{"action":{"defaultValue":null,"description":"The submit action, `logIn` or `signUp`","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthActionEnum"}},"type":{"defaultValue":{"value":"magiclink"},"description":"The authentication type, `magiclink` or `password`","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"AuthTypeEnum"}},"title":{"defaultValue":{"value":"Log in"},"description":"The form title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"submitLabel":{"defaultValue":{"value":"Log in"},"description":"Label for the submit button","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"Children are passed down to the underlying form\nThe child component","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"Render custom elements under the submit button","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"onSuccess":{"defaultValue":null,"description":"Callback executed after succesful login or signup","name":"onSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((data: any) => void)"}},"onError":{"defaultValue":null,"description":"Error handler if login or signup fails","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((error: Error) => void)"}},"onValidationError":{"defaultValue":null,"description":"Callback executed when there are validation errors","name":"onValidationError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((errors: FieldErrors) => void)"}},"providers":{"defaultValue":null,"description":"List of OAuth providers","name":"providers","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"AvailableProviders"}},"oauthRedirectUrl":{"defaultValue":null,"description":"The redirect URL after successful OAuth login","name":"oauthRedirectUrl","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}},"providerLabel":{"defaultValue":{"value":"Continue with"},"description":"Label for the provider buttons","name":"providerLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}},"dividerLabel":{"defaultValue":{"value":"or continue with"},"description":"Label for the divider between oath and the form","name":"dividerLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/MagicLinkForm.json b/tooling/props-docs/dist/components/MagicLinkForm.json new file mode 100644 index 000000000..4ac07b412 --- /dev/null +++ b/tooling/props-docs/dist/components/MagicLinkForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"MagicLinkForm","methods":[],"props":{"submitLabel":{"defaultValue":{"value":"Continue with Email"},"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/magic-link-form.tsx","name":"MagicLinkFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/magic-link-form.tsx","name":"MagicLinkFormProps"}],"required":false,"type":{"name":"string"}},"emailLabel":{"defaultValue":{"value":"Email"},"description":"","name":"emailLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/magic-link-form.tsx","name":"MagicLinkFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/magic-link-form.tsx","name":"MagicLinkFormProps"}],"required":false,"type":{"name":"string"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Menu.json b/tooling/props-docs/dist/components/Menu.json new file mode 100644 index 000000000..209c3cba8 --- /dev/null +++ b/tooling/props-docs/dist/components/Menu.json @@ -0,0 +1,182 @@ +{ + "ResponsiveMenu": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "autoSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens." + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "breakpoints": { + "type": "Record | (string | boolean)[]", + "defaultValue": "{ base: true, md: false }", + "required": false, + "description": "The breakpoints to use for the responsive menu." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when you click outside\nthe menu list" + }, + "closeOnSelect": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the menu will close when a menu item is\nclicked" + }, + "computePositionOnMount": { "type": "boolean", "required": false }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "required": false, + "description": "If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { "type": "string", "required": false }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isLazy": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open." + }, + "isOpen": { "type": "boolean", "required": false }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + } + }, + "MenuProperty": { + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false + }, + "value": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "MenuInput": { + "command": { "type": "string", "required": false }, + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is focused. Use color keys in `theme.colors`" + }, + "groupProps": { "type": "InputGroupProps", "required": false }, + "htmlSize": { + "type": "number", + "required": false, + "description": "The native HTML `size` attribute to be passed to the `input`" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + } + }, + "StyledMenuItem": {} +} diff --git a/tooling/props-docs/dist/components/MenuDialog.json b/tooling/props-docs/dist/components/MenuDialog.json new file mode 100644 index 000000000..6579a5235 --- /dev/null +++ b/tooling/props-docs/dist/components/MenuDialog.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"MenuDialog","methods":[],"props":{"footer":{"defaultValue":null,"description":"The modal footer, wrapped with `ModalFooter`","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"MenuDialogProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"MenuDialogProps"}],"required":false,"type":{"name":"ReactNode"}},"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"children":{"defaultValue":null,"description":"The modal children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":true,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; onClose: () => void; }>"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/MenuDialogList.json b/tooling/props-docs/dist/components/MenuDialogList.json new file mode 100644 index 000000000..9a030c9d4 --- /dev/null +++ b/tooling/props-docs/dist/components/MenuDialogList.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-modals/src/index.ts","description":"","displayName":"MenuDialogList","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/modal.tsx","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/MenuItem.json b/tooling/props-docs/dist/components/MenuItem.json new file mode 100644 index 000000000..9ea199f22 --- /dev/null +++ b/tooling/props-docs/dist/components/MenuItem.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"MenuItem","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"label":{"defaultValue":null,"description":"MenuItem label\nChildren always takes precedence over this prop.","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/menu/menu.tsx","name":"MenuItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/menu/menu.tsx","name":"MenuItemProps"}],"required":false,"type":{"name":"ReactNode"}},"href":{"defaultValue":null,"description":"Wraps the item with the link wrapper configured in SaasProvider.","name":"href","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/menu/menu.tsx","name":"MenuItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/menu/menu.tsx","name":"MenuItemProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/MinusIcon.json b/tooling/props-docs/dist/components/MinusIcon.json new file mode 100644 index 000000000..143c7623e --- /dev/null +++ b/tooling/props-docs/dist/components/MinusIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"MinusIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Modal.json b/tooling/props-docs/dist/components/Modal.json new file mode 100644 index 000000000..e3403379a --- /dev/null +++ b/tooling/props-docs/dist/components/Modal.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"Modal","methods":[],"props":{"title":{"defaultValue":null,"description":"The modal title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"children":{"defaultValue":null,"description":"The modal children","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":true,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; onClose: () => void; }>"}},"footer":{"defaultValue":null,"description":"The modal footer","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ReactNode"}},"hideCloseButton":{"defaultValue":null,"description":"Hide the close button","name":"hideCloseButton","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"hideOverlay":{"defaultValue":null,"description":"Hide the overlay","name":"hideOverlay","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"boolean"}},"headerProps":{"defaultValue":null,"description":"Props for the modal header","name":"headerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalHeaderProps"}},"contentProps":{"defaultValue":null,"description":"Props for the modal content","name":"contentProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalContentProps"}},"footerProps":{"defaultValue":null,"description":"Props for the modal footer","name":"footerProps","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"BaseModalProps"}],"required":false,"type":{"name":"ModalFooterProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Modals.json b/tooling/props-docs/dist/components/Modals.json new file mode 100644 index 000000000..05a24ee9e --- /dev/null +++ b/tooling/props-docs/dist/components/Modals.json @@ -0,0 +1,2124 @@ +{ + "ConfirmDialog": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "buttonGroupProps": { + "type": "ButtonGroupProps", + "required": false, + "description": "The button group props" + }, + "cancelLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The cancel button label" + }, + "cancelProps": { + "type": "ButtonProps", + "required": false, + "description": "The cancel button props" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnCancel": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Close the dialog on cancel" + }, + "closeOnConfirm": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Close the dialog on confirm" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "confirmLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The confirm button label" + }, + "confirmProps": { + "type": "ButtonProps", + "required": false, + "description": "The confirm button props" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "leastDestructiveFocus": { + "type": "\"cancel\" | \"confirm\"", + "required": false, + "description": "Defines which button gets initial focus\nhttps://www.w3.org/TR/wai-aria-practices/#alertdialog" + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onCancel": { + "type": "() => void", + "required": false, + "description": "Function that's called when cancel is clicked" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onConfirm": { + "type": "() => void | Promise", + "required": false, + "description": "Function that's called when confirm is clicked." + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The dialog title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "BaseDrawer": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The modal children" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overflow" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isFullHeight": { + "type": "boolean", + "required": false, + "description": "If `true` and drawer's placement is `top` or `bottom`,\nthe drawer will occupy the viewport height (100vh)" + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "placement": { + "type": "SlideDirection | LogicalPlacement", + "defaultValue": "right", + "required": false, + "description": "The placement of the drawer" + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The drawer title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "Drawer": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The modal children" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "colorScheme": { + "type": "\"whiteAlpha\" | \"blackAlpha\" | \"gray\" | \"red\" | \"orange\" | \"yellow\" | \"green\" | \"teal\" | \"blue\" | \"cyan\" | \"purple\" | \"pink\" | \"linkedin\" | \"facebook\" | \"messenger\" | \"whatsapp\" | \"twitter\" | \"telegram\"", + "required": false, + "description": "The visual color appearance of the component" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Drawer footer content, wrapped with `DrawerFooter`" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overflow" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isFullHeight": { + "type": "boolean", + "required": false, + "description": "If `true` and drawer's placement is `top` or `bottom`,\nthe drawer will occupy the viewport height (100vh)" + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "placement": { + "type": "SlideDirection | LogicalPlacement", + "defaultValue": "right", + "required": false, + "description": "The placement of the drawer" + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "size": { + "defaultValue": "xs", + "type": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"full\"", + "required": false, + "description": "The size of the Drawer" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The drawer title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + }, + "variant": { + "type": "string", + "required": false, + "description": "The variant of the Drawer" + } + }, + "BaseModal": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The modal children" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "MenuDialogList": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "motionProps": { + "type": "HTMLMotionProps<\"div\">", + "required": false, + "description": "The framer-motion props to animate the menu list" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "rootProps": { + "type": "HTMLChakraProps<\"div\">", + "required": false, + "description": "Props for the root element that positions the menu." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "MenuDialog": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The modal children" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer, wrapped with `ModalFooter`" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "FormDialog": { + "isOpen": { + "type": "boolean", + "required": true, + "description": "If `true`, the modal will be open." + }, + "onClose": { + "type": "() => void", + "required": true, + "description": "Callback invoked to close the modal." + }, + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: FormRenderContext<...>) => ReactNode)", + "required": false, + "description": "The form children, can be a render prop or a ReactNode." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "context": { "type": "TContext", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "type ONLY_FOR_FORMAT =\n | AsyncDefaultValues\n | DefaultValues", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "A schema field resolver used to auto generate form fields." + }, + "fields": { + "type": "FormDialogFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer, will be wrapped with `ModalFooter`.\nDefaults to a cancel and submit button." + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { + "type": "Resolver", + "required": false + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "NonNullable", + "required": false, + "description": "The form schema." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + }, + "values": { "type": "TFieldValues", "required": false } + }, + "ConfirmDialogOptions": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "buttonGroupProps": { + "type": "ButtonGroupProps", + "required": false, + "description": "The button group props" + }, + "cancelLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The cancel button label" + }, + "cancelProps": { + "type": "ButtonProps", + "required": false, + "description": "The cancel button props" + }, + "closeOnCancel": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Close the dialog on cancel" + }, + "closeOnConfirm": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Close the dialog on confirm" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "confirmLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The confirm button label" + }, + "confirmProps": { + "type": "ButtonProps", + "required": false, + "description": "The confirm button props" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "leastDestructiveFocus": { + "type": "\"cancel\" | \"confirm\"", + "required": false, + "description": "Defines which button gets initial focus\nhttps://www.w3.org/TR/wai-aria-practices/#alertdialog" + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onCancel": { + "type": "() => void", + "required": false, + "description": "Function that's called when cancel is clicked" + }, + "onClose": { + "type": "(args: {\n force?: boolean | undefined\n}) => void | Promise", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onConfirm": { + "type": "() => void | Promise", + "required": false, + "description": "Function that's called when confirm is clicked." + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "DrawerOptions": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "isFullHeight": { + "type": "boolean", + "required": false, + "description": "If `true` and drawer's placement is `top` or `bottom`,\nthe drawer will occupy the viewport height (100vh)" + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onClose": { + "type": "(args: {\n force?: boolean | undefined\n}) => void | Promise", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "placement": { + "type": "SlideDirection | LogicalPlacement", + "defaultValue": "right", + "required": false, + "description": "The placement of the drawer" + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "FormDialogOptions": { + "onSubmit": { + "type": "SubmitHandler", + "required": true, + "description": "The submit handler." + }, + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "context": { "type": "object", "required": false }, + "criteriaMode": { "type": "CriteriaMode", "required": false }, + "defaultValues": { + "type": "AsyncDefaultValues | { [x: string]: any }", + "required": false + }, + "delayError": { "type": "number", "required": false }, + "fieldResolver": { + "type": "FieldResolver", + "required": false, + "description": "A schema field resolver used to auto generate form fields." + }, + "fields": { + "type": "FormDialogFieldOverrides", + "required": false, + "description": "Field overrides" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "formRef": { + "type": "RefObject>", + "required": false, + "description": "The Hook Form state ref." + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "mode": { "type": "keyof ValidationMode", "required": false }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onChange": { + "type": "WatchObserver", + "required": false, + "description": "Triggers when any of the field change." + }, + "onClose": { + "type": "(args: {\n force?: boolean | undefined\n}) => void | Promise", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onError": { + "type": "SubmitErrorHandler", + "required": false, + "description": "Triggers when there are validation errors." + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "resetOptions": { + "type": "Partial<{\n keepDirtyValues: boolean\n keepErrors: boolean\n keepDirty: boolean\n keepValues: boolean\n keepDefaultValues: boolean\n keepIsSubmitted: boolean\n keepTouched: boolean\n keepIsValid: boolean\n keepSubmitCount: boolean\n}>", + "required": false + }, + "resolver": { "type": "Resolver", "required": false }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "reValidateMode": { + "type": "\"onBlur\" | \"onChange\" | \"onSubmit\"", + "required": false + }, + "schema": { + "type": "any", + "required": false, + "description": "The form schema." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "shouldFocusError": { "type": "boolean", "required": false }, + "shouldUnregister": { "type": "boolean", "required": false }, + "shouldUseNativeValidation": { "type": "boolean", "required": false }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + }, + "values": { "type": "FieldValues", "required": false } + }, + "MenuDialogOptions": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onClose": { + "type": "(args: {\n force?: boolean | undefined\n}) => void | Promise", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "ModalsProvider": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "modals": { "type": "TModals", "required": false } + }, + "OpenOptions": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "contentProps": { + "type": "ModalContentProps", + "required": false, + "description": "Props for the modal content" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal footer" + }, + "footerProps": { + "type": "ModalFooterProps", + "required": false, + "description": "Props for the modal footer" + }, + "headerProps": { + "type": "ModalHeaderProps", + "required": false, + "description": "Props for the modal header" + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onClose": { + "type": "(args: {\n force?: boolean | undefined\n}) => void | Promise", + "required": false + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scope": { "type": "ModalScopes", "required": false }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The modal title" + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "type": { "type": "TModalTypes", "required": false }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "CreateModalsOptions": { + "modals": { "type": "TModalDefs", "required": true } + } +} diff --git a/tooling/props-docs/dist/components/ModalsProvider.json b/tooling/props-docs/dist/components/ModalsProvider.json new file mode 100644 index 000000000..2defc056d --- /dev/null +++ b/tooling/props-docs/dist/components/ModalsProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"ModalsProvider","methods":[],"props":{"modals":{"defaultValue":null,"description":"","name":"modals","parent":{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ModalsProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/dist/index.d.ts","name":"ModalsProviderProps"}],"required":false,"type":{"name":"Record>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NProgress.json b/tooling/props-docs/dist/components/NProgress.json new file mode 100644 index 000000000..646b59e93 --- /dev/null +++ b/tooling/props-docs/dist/components/NProgress.json @@ -0,0 +1,9 @@ +{ + "NProgress": { + "isAnimating": { + "type": "boolean", + "required": true, + "description": "Set to true to start the progress animation." + } + } +} diff --git a/tooling/props-docs/dist/components/NativeSelect.json b/tooling/props-docs/dist/components/NativeSelect.json new file mode 100644 index 000000000..317d9cc5a --- /dev/null +++ b/tooling/props-docs/dist/components/NativeSelect.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"NativeSelect","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"options":{"defaultValue":null,"description":"","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/native-select.tsx","name":"NativeSelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/native-select.tsx","name":"NativeSelectOptions"}],"required":false,"type":{"name":"Option[]"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NativeSelectField.json b/tooling/props-docs/dist/components/NativeSelectField.json new file mode 100644 index 000000000..61b44a568 --- /dev/null +++ b/tooling/props-docs/dist/components/NativeSelectField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"NativeSelectField","methods":[],"props":{"options":{"defaultValue":null,"description":"","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NativeSelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NativeSelectOptions"}],"required":false,"type":{"name":"Option$1[]"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Nav.json b/tooling/props-docs/dist/components/Nav.json new file mode 100644 index 000000000..13ebf5532 --- /dev/null +++ b/tooling/props-docs/dist/components/Nav.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"Nav","methods":[],"props":{"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavProps"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NavGroup.json b/tooling/props-docs/dist/components/NavGroup.json new file mode 100644 index 000000000..0f530ef47 --- /dev/null +++ b/tooling/props-docs/dist/components/NavGroup.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/layout/sidebar"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Navigation group containing nav items, used in Sidebar.","displayName":"NavGroup","methods":[],"props":{"title":{"defaultValue":null,"description":"","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"ReactNode"}},"isCollapsible":{"defaultValue":null,"description":"","name":"isCollapsible","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"boolean"}},"defaultIsOpen":{"defaultValue":null,"description":"","name":"defaultIsOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"boolean"}},"onOpen":{"defaultValue":null,"description":"","name":"onOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"(() => void)"}},"onClose":{"defaultValue":null,"description":"","name":"onClose","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"(() => void)"}},"icon":{"defaultValue":null,"description":"","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupProps"}],"required":false,"type":{"name":"ReactElement>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NavGroupTitle.json b/tooling/props-docs/dist/components/NavGroupTitle.json new file mode 100644 index 000000000..8188878e5 --- /dev/null +++ b/tooling/props-docs/dist/components/NavGroupTitle.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"NavGroupTitle","methods":[],"props":{"leftIcon":{"defaultValue":null,"description":"","name":"leftIcon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"}],"required":false,"type":{"name":"ReactElement>"}},"collapseIcon":{"defaultValue":null,"description":"","name":"collapseIcon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"}],"required":false,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; }>"}},"isCollapsible":{"defaultValue":null,"description":"","name":"isCollapsible","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"NavGroupTitleProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NavItem.json b/tooling/props-docs/dist/components/NavItem.json new file mode 100644 index 000000000..2d2467cd8 --- /dev/null +++ b/tooling/props-docs/dist/components/NavItem.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/layout/sidebar"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"Navigation item used in the sidebar.","displayName":"NavItem","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"href":{"defaultValue":null,"description":"The href attribute of the nav item,\nwill be wrapped in a `Link`, if `linkComponent` is configured in SaasProvider.","name":"href","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"}],"required":false,"type":{"name":"string"}},"icon":{"defaultValue":null,"description":"Icon to be displayed in the nav item","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"}],"required":false,"type":{"name":"ReactElement>"}},"tooltipProps":{"defaultValue":null,"description":"Props to be passed to the tooltip\n@see Docs https://chakra-ui.com/docs/overlay/tooltip","name":"tooltipProps","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"}],"required":false,"type":{"name":"TooltipProps"}},"isActive":{"defaultValue":null,"description":"If `true`, the nav item will be active","name":"isActive","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/sidebar/nav-item.tsx","name":"NavItemProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NavItemLabel.json b/tooling/props-docs/dist/components/NavItemLabel.json new file mode 100644 index 000000000..eb76a2086 --- /dev/null +++ b/tooling/props-docs/dist/components/NavItemLabel.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"NavItemLabel","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Navbar.json b/tooling/props-docs/dist/components/Navbar.json new file mode 100644 index 000000000..379e1d24f --- /dev/null +++ b/tooling/props-docs/dist/components/Navbar.json @@ -0,0 +1,97 @@ +{ + "Navbar": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ReactNode[]", + "required": false + }, + "disableScrollHandler": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether the navbar parent scroll event should be listened to or not." + }, + "height": { + "type": "string | number", + "defaultValue": "\"3.5rem\" (56px)", + "required": false, + "description": "The height of the navbar." + }, + "motionProps": { + "type": "HTMLMotionProps<\"nav\">", + "required": false, + "description": "The props to modify the framer motion animation. Use the `variants` API to create your own animation.\nThis motion is only available if the `shouldHideOnScroll` prop is set to `true`." + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onScrollPositionChange": { + "type": "(scrollPosition: number) => void", + "required": false, + "description": "The scroll event handler for the navbar. The event fires when the navbar parent element is scrolled.\nit only works if `disableScrollHandler` is set to `false` or `shouldHideOnScroll` is set to `true`." + }, + "parentRef": { + "type": "RefObject", + "defaultValue": "`window`", + "required": false, + "description": "The parent element where the navbar is placed within.\nThis is used to determine the scroll position and whether the navbar should be hidden or not." + }, + "shouldHideOnScroll": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether the navbar should hide on scroll or not." + }, + "style": { + "type": "CSSProperties", + "required": false, + "description": "Style props to be applied to the navbar container." + } + }, + "NavbarBrand": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ReactNode[]", + "required": false + } + }, + "NavbarContent": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode\n | ReactNode[]", + "required": false, + "description": "Typically the `NavbarItem` component" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | \"initial\"\n | \"inherit\"\n | (string & {})\n | \"-moz-initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "Spacing between each navbar item" + } + }, + "NavbarItem": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Whether the item is active or not." + } + } +} diff --git a/tooling/props-docs/dist/components/NextButton.json b/tooling/props-docs/dist/components/NextButton.json new file mode 100644 index 000000000..b089de4e5 --- /dev/null +++ b/tooling/props-docs/dist/components/NextButton.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/step-form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"A button that submits the active step.","displayName":"NextButton","methods":[],"props":{"submitLabel":{"defaultValue":null,"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NextButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NextButtonProps"}],"required":false,"type":{"name":"string"}},"label":{"defaultValue":null,"description":"","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NextButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NextButtonProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NumberInput.json b/tooling/props-docs/dist/components/NumberInput.json new file mode 100644 index 000000000..b6b5089e7 --- /dev/null +++ b/tooling/props-docs/dist/components/NumberInput.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/number-input/index.ts","description":"","displayName":"NumberInput","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"hideStepper":{"defaultValue":{"value":false},"description":"Hide the stepper.","name":"hideStepper","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"}],"required":false,"type":{"name":"boolean"}},"incrementIcon":{"defaultValue":null,"description":"Render a custom increment icon.","name":"incrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}},"decrementIcon":{"defaultValue":null,"description":"Render a custom decrement icon.","name":"decrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/number-input/number-input.tsx","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/NumberInputField.json b/tooling/props-docs/dist/components/NumberInputField.json new file mode 100644 index 000000000..697653b3b --- /dev/null +++ b/tooling/props-docs/dist/components/NumberInputField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"NumberInputField","methods":[],"props":{"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputFieldProps"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"\"number\""}},"hideStepper":{"defaultValue":null,"description":"Hide the stepper.","name":"hideStepper","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"boolean"}},"incrementIcon":{"defaultValue":null,"description":"Render a custom increment icon.","name":"incrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}},"decrementIcon":{"defaultValue":null,"description":"Render a custom decrement icon.","name":"decrementIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"NumberInputOptions"}],"required":false,"type":{"name":"ReactNode"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ObjectField.json b/tooling/props-docs/dist/components/ObjectField.json new file mode 100644 index 000000000..997a40199 --- /dev/null +++ b/tooling/props-docs/dist/components/ObjectField.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/object-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The object field component.","displayName":"ObjectField","methods":[],"props":{"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"}],"required":true,"type":{"name":"string"}},"columns":{"defaultValue":null,"description":"","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ObjectFieldProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Onboarding.json b/tooling/props-docs/dist/components/Onboarding.json new file mode 100644 index 000000000..3425afc2e --- /dev/null +++ b/tooling/props-docs/dist/components/Onboarding.json @@ -0,0 +1,1005 @@ +{ + "Beacon": {}, + "BenefitsModalContainer": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the modal will be centered on screen." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the modal will be open." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback invoked to close the modal." + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "BenefitsModalMedia": { + "ratio": { + "type": "ResponsiveValue", + "required": false, + "description": "The aspect ratio of the Box. Common values are:\n\n`21/9`, `16/9`, `9/16`, `4/3`, `1.85/1`" + }, + "src": { "type": "string", "required": false } + }, + "BenefitsModal": { + "allowPinchZoom": { + "type": "boolean", + "defaultValue": "false.", + "required": false, + "description": "Handle zoom/pinch gestures on iOS devices when scroll locking is enabled." + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will autofocus the first enabled and interactive\nelement within the `ModalContent`" + }, + "blockScrollOnMount": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, scrolling will be disabled on the `body` when the modal opens." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the `Esc` key is pressed" + }, + "closeOnOverlayClick": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will close when the overlay is clicked" + }, + "finalFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal closes." + }, + "hideCloseButton": { + "type": "boolean", + "required": false, + "description": "Hide the close button" + }, + "hideOverlay": { + "type": "boolean", + "required": false, + "description": "Hide the overlay" + }, + "id": { + "type": "string", + "required": false, + "description": "The `id` of the modal" + }, + "initialFocusRef": { + "type": "RefObject", + "required": false, + "description": "The `ref` of element to receive focus when the modal opens." + }, + "isCentered": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Render the modal in the center of the screen" + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the modal will be open." + }, + "lockFocusAcrossFrames": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "Enables aggressive focus capturing within iframes.\n- If `true`: keep focus in the lock, no matter where lock is active\n- If `false`: allows focus to move outside of iframe" + }, + "motionPreset": { + "type": "MotionPreset", + "defaultValue": "scale", + "required": false, + "description": "The transition that should be used for the modal" + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback invoked to close the modal." + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Fires when all exiting nodes have completed animating out" + }, + "onEsc": { + "type": "() => void", + "required": false, + "description": "Callback fired when the escape key is pressed and focus is within modal" + }, + "onOverlayClick": { + "type": "() => void", + "required": false, + "description": "Callback fired when the overlay is clicked." + }, + "portalProps": { + "type": "Pick<\n PortalProps,\n \"appendToParentPortal\" | \"containerRef\"\n>", + "required": false, + "description": "Props to be forwarded to the portal component" + }, + "preserveScrollBarGap": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, a `padding-right` will be applied to the body element\nthat's equal to the width of the scrollbar.\n\nThis can help prevent some unpleasant flickering effect\nand content adjustment when the modal opens" + }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the modal will return focus to the element that triggered it when it closes." + }, + "scrollBehavior": { + "type": "ScrollBehavior", + "defaultValue": "outside", + "required": false, + "description": "Where scroll behavior should originate.\n- If set to `inside`, scroll only occurs within the `ModalBody`.\n- If set to `outside`, the entire `ModalContent` will scroll within the viewport." + }, + "trapFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `false`, focus lock will be disabled completely.\n\nThis is useful in situations where you still need to interact with\nother surrounding elements.\n\n🚨Warning: We don't recommend doing this because it hurts the\naccessibility of the modal, based on WAI-ARIA specifications." + }, + "useInert": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "A11y: If `true`, the siblings of the `modal` will have `aria-hidden`\nset to `true` so that screen readers can only see the `modal`.\n\nThis is commonly known as making the other elements **inert**" + } + }, + "TourDialogActions": { + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "primaryActionProps": { "type": "ButtonProps", "required": false }, + "secondaryActionProps": { "type": "ButtonProps", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + } + }, + "TourDialogContainer": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onSubmit": { "type": "() => Promise", "required": false }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "primaryAction": { "type": "ButtonProps", "required": false }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "secondaryAction": { "type": "ButtonProps", "required": false }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + } + }, + "TourDialog": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "data-target": { + "type": "string", + "required": false, + "description": "The Spotlight target when used in a Tour." + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "hideArrow": { + "type": "boolean", + "required": false, + "description": "Hide the arrow" + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onSubmit": { "type": "() => Promise", "required": false }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "primaryAction": { "type": "ButtonProps", "required": false }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "secondaryAction": { "type": "ButtonProps", "required": false }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + } + }, + "Tour": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "defaultIsActive": { + "type": "boolean", + "required": false, + "description": "Activate the tour by default." + }, + "initialStep": { + "type": "number", + "required": false, + "description": "The initial step index." + }, + "isActive": { + "type": "boolean", + "required": false, + "description": "Make the tour controlled." + }, + "onComplete": { + "type": "() => void", + "required": false, + "description": "Called when the last step is completed." + }, + "onDismiss": { + "type": "(index: number) => void", + "required": false, + "description": "Called when the current step is closed or dismissed." + } + }, + "UseTourBeacon": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the tooltip will be initially shown" + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { + "type": "string", + "required": false, + "description": "Custom `id` to use in place of `uuid`" + }, + "isDisabled": { "type": "boolean", "required": false }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the tooltip will be shown (in controlled mode)" + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback to run when the tooltip hides" + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback to run when the tooltip shows" + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + } + }, + "TourDialogOptions": { + "arrowPadding": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The padding required to prevent the arrow from\nreaching the very edge of the popper." + }, + "arrowShadowColor": { + "type": "string", + "required": false, + "description": "The `box-shadow` of the popover arrow" + }, + "arrowSize": { + "type": "number", + "required": false, + "description": "The size of the popover arrow" + }, + "autoFocus": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be transferred to the first interactive element\nwhen the popover opens" + }, + "boundary": { + "type": "HTMLElement | \"clippingParents\" | \"scrollParent\"", + "defaultValue": "clippingParents", + "required": false, + "description": "The boundary area for the popper. Used within the `preventOverflow` modifier" + }, + "children": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false, + "description": "The content of the popover. It is usually the `PopoverTrigger`,\nand `PopoverContent`" + }, + "closeDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover closes after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "closeOnBlur": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you blur out it by\nclicking outside or tabbing out" + }, + "closeOnEsc": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popover will close when you hit the `Esc` key" + }, + "computePositionOnMount": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be positioned when it mounts\n(even if it's not open)\n\nNote 🚨: We don't recommend using this in a popover/menu intensive UI or page\nas it might affect scrolling performance." + }, + "defaultIsOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be initially opened." + }, + "direction": { + "type": "\"ltr\" | \"rtl\"", + "defaultValue": "ltr", + "required": false, + "description": "Theme direction `ltr` or `rtl`. Popper's placement will\nbe set accordingly" + }, + "eventListeners": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | { scroll?: boolean | undefined; resize?: boolean | undefined }", + "defaultValue": true, + "required": false, + "description": "If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window." + }, + "flip": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area." + }, + "gutter": { + "type": "number", + "defaultValue": "8", + "required": false, + "description": "The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter." + }, + "id": { + "type": "string", + "required": false, + "description": "The html `id` attribute of the popover.\nIf not provided, we generate a unique id.\n\nThis `id` is also used to auto-generate the `aria-labelledby`\nand `aria-describedby` attributes that points to the `PopoverHeader` and `PopoverBody`" + }, + "initialFocusRef": { + "type": "RefObject<{ focus(): void }>", + "required": false, + "description": "The `ref` of the element that should receive focus when the popover opens." + }, + "isLazy": { + "type": "boolean", + "required": false, + "description": "Performance 🚀:\nIf `true`, the PopoverContent rendering will be deferred\nuntil the popover is open." + }, + "isOpen": { + "type": "boolean", + "required": false, + "description": "If `true`, the popover will be opened in controlled mode." + }, + "lazyBehavior": { + "type": "LazyMode", + "defaultValue": "unmount", + "required": false, + "description": "Performance 🚀:\nThe lazy behavior of popover's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The popover's content is always unmounted when not open.\n- \"keepMounted\": The popover's content initially unmounted,\nbut stays mounted when popover is open." + }, + "matchWidth": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns." + }, + "modifiers": { + "type": "Partial>[]", + "required": false, + "description": "Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass." + }, + "offset": { + "type": "[number, number]", + "required": false, + "description": "The main and cross-axis offset to displace popper element\nfrom its reference element." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover closes" + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback fired when the popover opens" + }, + "onSubmit": { "type": "() => Promise", "required": false }, + "openDelay": { + "type": "number", + "defaultValue": "200", + "required": false, + "description": "Delay in milliseconds before the popover opens after a trigger event.\nOnly works when `trigger=\"hover\"`" + }, + "placement": { + "type": "PlacementWithLogical", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the popper relative to its reference." + }, + "preventOverflow": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area." + }, + "primaryAction": { "type": "ButtonProps", "required": false }, + "returnFocusOnClose": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, focus will be returned to the element that triggers the popover\nwhen it closes" + }, + "secondaryAction": { "type": "ButtonProps", "required": false }, + "strategy": { + "type": "\"fixed\" | \"absolute\"", + "defaultValue": "absolute", + "required": false, + "description": "The CSS positioning strategy to use." + }, + "trigger": { + "type": "\"click\" | \"hover\"", + "defaultValue": "click", + "required": false, + "description": "The interaction that triggers the popover.\n\n`hover` - means the popover will open when you hover with mouse or\nfocus with keyboard on the popover trigger\n\n`click` - means the popover will open on click or\npress `Enter` to `Space` on keyboard" + } + }, + "TourSpotlightOptions": { + "closeOnClick": { "type": "boolean", "required": false }, + "hideOverlay": { "type": "boolean", "required": false }, + "motionPreset": { "type": "\"fade\" | \"none\"", "required": false }, + "spacing": { "type": "number", "required": false } + }, + "TourSpotlight": { + "closeOnClick": { "type": "boolean", "required": false }, + "hideOverlay": { "type": "boolean", "required": false }, + "motionPreset": { "type": "\"fade\" | \"none\"", "required": false }, + "spacing": { "type": "number", "required": false } + }, + "TourOptions": { + "defaultIsActive": { + "type": "boolean", + "required": false, + "description": "Activate the tour by default." + }, + "initialStep": { + "type": "number", + "required": false, + "description": "The initial step index." + }, + "isActive": { + "type": "boolean", + "required": false, + "description": "Make the tour controlled." + }, + "onComplete": { + "type": "() => void", + "required": false, + "description": "Called when the last step is completed." + }, + "onDismiss": { + "type": "(index: number) => void", + "required": false, + "description": "Called when the current step is closed or dismissed." + } + }, + "UseTour": { + "steps": { "type": "TourStep[]", "required": true }, + "defaultIsActive": { + "type": "boolean", + "required": false, + "description": "Activate the tour by default." + }, + "initialStep": { + "type": "number", + "required": false, + "description": "The initial step index." + }, + "isActive": { + "type": "boolean", + "required": false, + "description": "Make the tour controlled." + }, + "onComplete": { + "type": "() => void", + "required": false, + "description": "Called when the last step is completed." + }, + "onDismiss": { + "type": "(index: number) => void", + "required": false, + "description": "Called when the current step is closed or dismissed." + } + } +} diff --git a/tooling/props-docs/dist/components/OtpForm.json b/tooling/props-docs/dist/components/OtpForm.json new file mode 100644 index 000000000..4defea624 --- /dev/null +++ b/tooling/props-docs/dist/components/OtpForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"OtpForm","methods":[],"props":{"otpLabel":{"defaultValue":{"value":"Your verification code"},"description":"","name":"otpLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"string"}},"helpText":{"defaultValue":{"value":"You can find your one-time password in the Google Authenticator or Authy app."},"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"string"}},"pinLength":{"defaultValue":{"value":4},"description":"","name":"pinLength","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"number"}},"submitLabel":{"defaultValue":{"value":"Verify"},"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"The form children, can be a render prop or a ReactNode.","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"ReactNode"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/OtpView.json b/tooling/props-docs/dist/components/OtpView.json new file mode 100644 index 000000000..646354881 --- /dev/null +++ b/tooling/props-docs/dist/components/OtpView.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"OtpView","methods":[],"props":{"renderSuccess":{"defaultValue":null,"description":"","name":"renderSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/otp-view.tsx","name":"OtpViewProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/otp-view.tsx","name":"OtpViewProps"}],"required":false,"type":{"name":"((data: any) => ReactElement>)"}},"action":{"defaultValue":null,"description":"The submit action, `logIn` or `signUp`","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthActionEnum"}},"type":{"defaultValue":null,"description":"The authentication type, `magiclink` or `password`","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthTypeEnum"}},"title":{"defaultValue":{"value":"One-time password"},"description":"The form title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"submitLabel":{"defaultValue":{"value":"\"Sign in\""},"description":"Label for the submit button","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"Children are passed down to the underlying form","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"Render custom elements under the submit button","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"onSuccess":{"defaultValue":null,"description":"Callback executed after succesful login or signup","name":"onSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((data: any) => void)"}},"onError":{"defaultValue":null,"description":"Error handler if login or signup fails","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((error: Error) => void)"}},"onValidationError":{"defaultValue":null,"description":"Callback executed when there are validation errors","name":"onValidationError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((errors: FieldErrors) => void)"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"pinLength":{"defaultValue":null,"description":"","name":"pinLength","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"number"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}},"helpText":{"defaultValue":null,"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"string"}},"otpLabel":{"defaultValue":null,"description":"","name":"otpLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/otp-form.tsx","name":"OtpFormProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/OverflowMenu.json b/tooling/props-docs/dist/components/OverflowMenu.json new file mode 100644 index 000000000..227a91575 --- /dev/null +++ b/tooling/props-docs/dist/components/OverflowMenu.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"OverflowMenu","methods":[],"props":{"label":{"defaultValue":null,"description":"The button (aria) label.","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"}],"required":false,"type":{"name":"string"}},"variant":{"defaultValue":null,"description":"The MenuButton variant.","name":"variant","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"}],"required":false,"type":{"name":"\"link\" | (string & {}) | \"outline\" | \"solid\" | \"primary\" | \"secondary\" | \"ghost\" | \"unstyled\" | \"subtle\" | \"elevated\" | \"tertiary\""}},"size":{"defaultValue":null,"description":"The MenuButton size","name":"size","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"}],"required":false,"type":{"name":"(string & {}) | \"sm\" | \"md\" | \"lg\" | \"xs\""}},"menuListProps":{"defaultValue":null,"description":"Props passed to the MenuList.","name":"menuListProps","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"}],"required":false,"type":{"name":"MenuListProps"}},"icon":{"defaultValue":null,"description":"Render a custom icon.","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"OverflowMenuProps"}],"required":false,"type":{"name":"ReactElement>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Page.json b/tooling/props-docs/dist/components/Page.json new file mode 100644 index 000000000..e87eb04a6 --- /dev/null +++ b/tooling/props-docs/dist/components/Page.json @@ -0,0 +1,2313 @@ +{ + "PageHeader": { + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "nav": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "toolbar": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "PageOptions": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "errorComponent": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "hasError": { "type": "boolean", "required": false }, + "isLoading": { "type": "boolean", "required": false }, + "skeleton": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "Page": { + "query": { "type": "Record", "required": true }, + "locale": { "type": "string", "required": false } + }, + "PageBody": { + "contentProps": { "type": "HTMLChakraProps<\"div\">", "required": false }, + "contentWidth": { + "type": "ResponsiveValue", + "required": false + } + }, + "ErrorPage": { + "actions": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "footer": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "icon": { "type": "As", "required": false }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "BackButton": { + "aria-label": { "type": "string", "required": false }, + "href": { "type": "string | object", "required": false }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The icon to be used in the button." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "isRound": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be perfectly round. Else, it'll be slightly round" + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + } + }, + "SectionBody": {}, + "SectionHeader": { + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "Section": { + "children": { + "type": "ItemElement | ItemElement[] | ItemRenderer", + "required": true, + "description": "Static child items or a function to render children." + }, + "aria-label": { + "type": "string", + "required": false, + "description": "An accessibility label for the section." + }, + "items": { + "type": "Iterable", + "required": false, + "description": "Item objects in the section." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Rendered contents of the section, e.g. a header." + } + }, + "SplitPage": { + "children": { + "type": "[\n ReactElement>,\n ReactElement>\n]", + "required": true + }, + "breakpoint": { "type": "string", "required": false }, + "breakpoints": { + "type": "Record | (string | boolean)[]", + "required": false + }, + "defaultIsOpen": { "type": "boolean", "required": false }, + "isOpen": { "type": "boolean", "required": false }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "orientation": { + "type": "\"vertical\" | \"horizontal\"", + "required": false + } + }, + "AsideContainer": { + "_dragX": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "_dragY": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "about": { "type": "string", "required": false }, + "accessKey": { "type": "string", "required": false }, + "animate": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | AnimationControls\n | TargetAndTransition\n | VariantLabels", + "required": false, + "description": "Values to animate to, variant label(s), or `AnimationControls`.\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// AnimationControls\n\n```" + }, + "aria-activedescendant": { "type": "string", "required": false }, + "aria-atomic": { "type": "Booleanish", "required": false }, + "aria-autocomplete": { + "type": "\"none\" | \"list\" | \"inline\" | \"both\"", + "required": false + }, + "aria-braillelabel": { "type": "string", "required": false }, + "aria-brailleroledescription": { "type": "string", "required": false }, + "aria-busy": { "type": "Booleanish", "required": false }, + "aria-checked": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-colcount": { "type": "number", "required": false }, + "aria-colindex": { "type": "number", "required": false }, + "aria-colindextext": { "type": "string", "required": false }, + "aria-colspan": { "type": "number", "required": false }, + "aria-controls": { "type": "string", "required": false }, + "aria-current": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"time\"\n | \"page\"\n | \"true\"\n | \"false\"\n | \"step\"\n | \"location\"\n | \"date\"", + "required": false + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-description": { "type": "string", "required": false }, + "aria-details": { "type": "string", "required": false }, + "aria-disabled": { "type": "Booleanish", "required": false }, + "aria-dropeffect": { + "type": "\"link\" | \"none\" | \"copy\" | \"move\" | \"execute\" | \"popup\"", + "required": false + }, + "aria-errormessage": { "type": "string", "required": false }, + "aria-expanded": { "type": "Booleanish", "required": false }, + "aria-flowto": { "type": "string", "required": false }, + "aria-grabbed": { "type": "Booleanish", "required": false }, + "aria-haspopup": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"dialog\"\n | \"menu\"\n | \"grid\"\n | \"true\"\n | \"false\"\n | \"listbox\"\n | \"tree\"", + "required": false + }, + "aria-hidden": { "type": "Booleanish", "required": false }, + "aria-invalid": { + "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", + "required": false + }, + "aria-keyshortcuts": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "aria-level": { "type": "number", "required": false }, + "aria-live": { + "type": "\"off\" | \"assertive\" | \"polite\"", + "required": false + }, + "aria-modal": { "type": "Booleanish", "required": false }, + "aria-multiline": { "type": "Booleanish", "required": false }, + "aria-multiselectable": { "type": "Booleanish", "required": false }, + "aria-orientation": { + "type": "\"vertical\" | \"horizontal\"", + "required": false + }, + "aria-owns": { "type": "string", "required": false }, + "aria-placeholder": { "type": "string", "required": false }, + "aria-posinset": { "type": "number", "required": false }, + "aria-pressed": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-readonly": { "type": "Booleanish", "required": false }, + "aria-relevant": { + "type": "type ONLY_FOR_FORMAT =\n | \"text\"\n | \"all\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", + "required": false + }, + "aria-required": { "type": "Booleanish", "required": false }, + "aria-roledescription": { "type": "string", "required": false }, + "aria-rowcount": { "type": "number", "required": false }, + "aria-rowindex": { "type": "number", "required": false }, + "aria-rowindextext": { "type": "string", "required": false }, + "aria-rowspan": { "type": "number", "required": false }, + "aria-selected": { "type": "Booleanish", "required": false }, + "aria-setsize": { "type": "number", "required": false }, + "aria-sort": { + "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", + "required": false + }, + "aria-valuemax": { "type": "number", "required": false }, + "aria-valuemin": { "type": "number", "required": false }, + "aria-valuenow": { "type": "number", "required": false }, + "aria-valuetext": { "type": "string", "required": false }, + "autoCapitalize": { "type": "string", "required": false }, + "autoCorrect": { "type": "string", "required": false }, + "autoFocus": { "type": "boolean", "required": false }, + "autoSave": { "type": "string", "required": false }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "className": { "type": "string", "required": false }, + "content": { "type": "string", "required": false }, + "contentEditable": { + "type": "\"inherit\" | Booleanish", + "required": false + }, + "contextMenu": { "type": "string", "required": false }, + "custom": { + "type": "any", + "required": false, + "description": "Custom data to use to resolve dynamic variants differently for each animating component.\n\n```jsx\nconst variants = {\n visible: (custom) => ({\n opacity: 1,\n transition: { delay: custom * 0.2 }\n })\n}\n\n\n\n\n```" + }, + "dangerouslySetInnerHTML": { + "type": "{ __html: string | TrustedHTML }", + "required": false + }, + "datatype": { "type": "string", "required": false }, + "defaultChecked": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | number | readonly string[]", + "required": false + }, + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "dir": { "type": "string", "required": false }, + "drag": { + "type": "boolean | \"x\" | \"y\"", + "required": false, + "description": "Enable dragging for this element. Set to `false` by default.\nSet `true` to drag in both directions.\nSet `\"x\"` or `\"y\"` to only drag in a specific direction.\n\n```jsx\n\n```" + }, + "dragConstraints": { + "type": "false | Partial | RefObject", + "required": false, + "description": "Applies constraints on the permitted draggable area.\n\nIt can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels.\nThis will define a distance the named edge of the draggable component.\n\nAlternatively, it can accept a `ref` to another component created with React's `useRef` hook.\nThis `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref`\nof the component you want to use as constraints.\n\n```jsx\n// In pixels\n\n\n// As a ref to another component\nconst MyComponent = () => {\n const constraintsRef = useRef(null)\n\n return (\n \n \n \n )\n}\n```" + }, + "dragControls": { + "type": "DragControls", + "required": false, + "description": "Usually, dragging is initiated by pressing down on a component and moving it. For some\nuse-cases, for instance clicking at an arbitrary point on a video scrubber, we\nmight want to initiate dragging from a different component than the draggable one.\n\nBy creating a `dragControls` using the `useDragControls` hook, we can pass this into\nthe draggable component's `dragControls` prop. It exposes a `start` method\nthat can start dragging from pointer events on other components.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragDirectionLock": { + "type": "boolean", + "required": false, + "description": "If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n\n```jsx\n\n```" + }, + "dragElastic": { + "type": "DragElastic", + "required": false, + "description": "The degree of movement allowed outside constraints. 0 = no movement, 1 =\nfull movement.\n\nSet to `0.5` by default. Can also be set as `false` to disable movement.\n\nBy passing an object of `top`/`right`/`bottom`/`left`, individual values can be set\nper constraint. Any missing values will be set to `0`.\n\n```jsx\n\n```" + }, + "draggable": { "type": "Booleanish", "required": false }, + "dragListener": { + "type": "boolean", + "required": false, + "description": "By default, if `drag` is defined on a component then an event listener will be attached\nto automatically initiate dragging when a user presses down on it.\n\nBy setting `dragListener` to `false`, this event listener will not be created.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragMomentum": { + "type": "boolean", + "required": false, + "description": "Apply momentum from the pan gesture to the component when dragging\nfinishes. Set to `true` by default.\n\n```jsx\n\n```" + }, + "dragPropagation": { + "type": "boolean", + "required": false, + "description": "Allows drag gesture propagation to child components. Set to `false` by\ndefault.\n\n```jsx\n\n```" + }, + "dragSnapToOrigin": { + "type": "boolean", + "required": false, + "description": "If true, element will snap back to its origin when dragging ends.\n\nEnabling this is the equivalent of setting all `dragConstraints` axes to `0`\nwith `dragElastic={1}`, but when used together `dragConstraints` can define\na wider draggable area and `dragSnapToOrigin` will ensure the element\nanimates back to its origin on release." + }, + "dragTransition": { + "type": "Partial>", + "required": false, + "description": "Allows you to change dragging inertia parameters.\nWhen releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it.\nSee \n{@link \nhttps://framer.com/api/animation/#inertia Inertia\n}\n for all properties you can use.\n\n```jsx\n\n```" + }, + "exit": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "A target to animate to when this component is removed from the tree.\n\nThis component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n\nThis limitation exists because React doesn't allow components to defer unmounting until after\nan animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n\n```jsx\nimport { AnimatePresence, motion } from 'framer-motion'\n\nexport const MyComponent = ({ isVisible }) => {\n return (\n \n {isVisible && (\n \n )}\n \n )\n}\n```" + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "hidden": { "type": "boolean", "required": false }, + "id": { "type": "string", "required": false }, + "ignoreStrict": { "type": "boolean", "required": false }, + "inherit": { "type": "boolean", "required": false }, + "initial": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | MakeCustomValueType\n | VariantLabels", + "required": false, + "description": "Properties, variant label or array of variant labels to start in.\n\nSet to `false` to initialise with the values in `animate` (disabling the mount animation)\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// As false (disable mount animation)\n\n```" + }, + "inlist": { "type": "any", "required": false }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"text\"\n | \"none\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"", + "required": false + }, + "is": { "type": "string", "required": false }, + "isOpen": { "type": "boolean", "required": false }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "itemID": { "type": "string", "required": false }, + "itemProp": { "type": "string", "required": false }, + "itemRef": { "type": "string", "required": false }, + "itemScope": { "type": "boolean", "required": false }, + "itemType": { "type": "string", "required": false }, + "lang": { "type": "string", "required": false }, + "layout": { + "type": "boolean | \"position\" | \"size\" | \"preserve-aspect\"", + "required": false, + "description": "If `true`, this component will automatically animate to its new position when\nits layout changes.\n\n```jsx\n\n```\n\nThis will perform a layout animation using performant transforms. Part of this technique\ninvolved animating an element's scale. This can introduce visual distortions on children,\n`boxShadow` and `borderRadius`.\n\nTo correct distortion on immediate children, add `layout` to those too.\n\n`boxShadow` and `borderRadius` will automatically be corrected if they are already being\nanimated on this component. Otherwise, set them directly via the `initial` prop.\n\nIf `layout` is set to `\"position\"`, the size of the component will change instantly and\nonly its position will animate. If `layout` is set to `\"size\"`, the position of the\ncomponent will change instantly but its size will animate.\n\nIf `layout` is set to `\"size\"`, the position of the component will change instantly and\nonly its size will animate.\n\nIf `layout` is set to `\"preserve-aspect\"`, the component will animate size & position if\nthe aspect ratio remains the same between renders, and just position if the ratio changes." + }, + "layoutDependency": { "type": "any", "required": false }, + "layoutId": { + "type": "string", + "required": false, + "description": "Enable shared layout transitions between different components with the same `layoutId`.\n\nWhen a component with a layoutId is removed from the React tree, and then\nadded elsewhere, it will visually animate from the previous component's bounding box\nand its latest animated values.\n\n```jsx\n {items.map(item => (\n \n {item.name}\n {item.isSelected && }\n \n ))}\n```\n\nIf the previous component remains in the tree it will crossfade with the new component." + }, + "layoutRoot": { + "type": "boolean", + "required": false, + "description": "Whether an element should be considered a \"layout root\", where\nall children will be forced to resolve relatively to it.\nCurrently used for `position: sticky` elements in Framer." + }, + "layoutScroll": { + "type": "boolean", + "required": false, + "description": "Whether a projection node should measure its scroll when it or its descendants update their layout." + }, + "nonce": { "type": "string", "required": false }, + "onAbort": { + "type": "ReactEventHandler", + "required": false + }, + "onAbortCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onAnimationComplete": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` is complete.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has completed.\n\n```jsx\nfunction onComplete() {\n console.log(\"Animation completed\")\n}\n\n {\n console.log('Completed animating', definition)\n }}\n/>\n```" + }, + "onAnimationEnd": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationEndCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIteration": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIterationCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onAnimationStartCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAuxClick": { + "type": "MouseEventHandler", + "required": false + }, + "onAuxClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onBeforeInput": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeLayoutMeasure": { + "type": "(box: Box) => void", + "required": false + }, + "onBlur": { + "type": "FocusEventHandler", + "required": false + }, + "onBlurCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onCanPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThrough": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThroughCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onChange": { + "type": "FormEventHandler", + "required": false + }, + "onChangeCapture": { + "type": "FormEventHandler", + "required": false + }, + "onClick": { + "type": "MouseEventHandler", + "required": false + }, + "onClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCompositionEnd": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionEndCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStart": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStartCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdate": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdateCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onContextMenu": { + "type": "MouseEventHandler", + "required": false + }, + "onContextMenuCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCopy": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCopyCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCut": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCutCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onDirectionLock": { + "type": "(axis: \"x\" | \"y\") => void", + "required": false, + "description": "Callback function that fires a drag direction is determined.\n\n```jsx\n console.log(axis)}\n/>\n```" + }, + "onDoubleClick": { + "type": "MouseEventHandler", + "required": false + }, + "onDoubleClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEndCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnter": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnterCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragExit": { + "type": "DragEventHandler", + "required": false + }, + "onDragExitCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeave": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeaveCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragOver": { + "type": "DragEventHandler", + "required": false + }, + "onDragOverCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStartCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragTransitionEnd": { + "type": "() => void", + "required": false, + "description": "Callback function that fires when drag momentum/bounce transition finishes.\n\n```jsx\n console.log('Drag transition complete')}\n/>\n```" + }, + "onDrop": { "type": "DragEventHandler", "required": false }, + "onDropCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDurationChange": { + "type": "ReactEventHandler", + "required": false + }, + "onDurationChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptied": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptiedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEncrypted": { + "type": "ReactEventHandler", + "required": false + }, + "onEncryptedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEnded": { + "type": "ReactEventHandler", + "required": false + }, + "onEndedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onError": { + "type": "ReactEventHandler", + "required": false + }, + "onErrorCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onFocus": { + "type": "FocusEventHandler", + "required": false + }, + "onFocusCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onGotPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onGotPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onHoverEnd": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer stops hovering over the component.\n\n```jsx\n console.log(\"Hover ends\")} />\n```" + }, + "onHoverStart": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer starts hovering over the component.\n\n```jsx\n console.log('Hover starts')} />\n```" + }, + "onInput": { + "type": "FormEventHandler", + "required": false + }, + "onInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onInvalid": { + "type": "FormEventHandler", + "required": false + }, + "onInvalidCapture": { + "type": "FormEventHandler", + "required": false + }, + "onKeyDown": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyDownCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPress": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPressCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUp": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUpCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onLayoutAnimationComplete": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component completes." + }, + "onLayoutAnimationStart": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component starts." + }, + "onLayoutMeasure": { + "type": "(box: Box, prevBox: Box) => void", + "required": false + }, + "onLoad": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedData": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedDataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadata": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStart": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStartCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLostPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onLostPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onMeasureDragConstraints": { + "type": "(constraints: BoundingBox) => void | BoundingBox", + "required": false, + "description": "If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints." + }, + "onMouseDown": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseDownCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseEnter": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseLeave": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMove": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMoveCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOut": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOutCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOver": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOverCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUp": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUpCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onPan": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture is recognised on this element.\n\n**Note:** For pan gestures to work correctly with touch input, the element needs\ntouch scrolling to be disabled on either x/y or both axis with the\n[touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) CSS rule.\n\n```jsx\nfunction onPan(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanEnd": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture ends on this element.\n\n```jsx\nfunction onPanEnd(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanSessionStart": { + "type": "(event: PointerEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when we begin detecting a pan gesture. This\nis analogous to `onMouseStart` or `onTouchStart`.\n\n```jsx\nfunction onPanSessionStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanStart": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture begins on this element.\n\n```jsx\nfunction onPanStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPaste": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPasteCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPause": { + "type": "ReactEventHandler", + "required": false + }, + "onPauseCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlaying": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPointerCancel": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerCancelCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDown": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDownCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnter": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnterCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeave": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeaveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMove": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMoveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOut": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOutCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOver": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOverCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUp": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUpCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onProgress": { + "type": "ReactEventHandler", + "required": false + }, + "onProgressCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChange": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onReset": { + "type": "FormEventHandler", + "required": false + }, + "onResetCapture": { + "type": "FormEventHandler", + "required": false + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + }, + "onResizeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onScroll": { "type": "UIEventHandler", "required": false }, + "onScrollCapture": { + "type": "UIEventHandler", + "required": false + }, + "onSeeked": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSeeking": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSelect": { + "type": "ReactEventHandler", + "required": false + }, + "onSelectCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onStalled": { + "type": "ReactEventHandler", + "required": false + }, + "onStalledCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSubmit": { + "type": "FormEventHandler", + "required": false + }, + "onSubmitCapture": { + "type": "FormEventHandler", + "required": false + }, + "onSuspend": { + "type": "ReactEventHandler", + "required": false + }, + "onSuspendCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTap": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture successfully ends on this element.\n\n```jsx\nfunction onTap(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapCancel": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture ends outside this element.\n\n```jsx\nfunction onTapCancel(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture starts on this element.\n\n```jsx\nfunction onTapStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTimeUpdate": { + "type": "ReactEventHandler", + "required": false + }, + "onTimeUpdateCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTouchCancel": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchCancelCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEnd": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEndCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMove": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMoveCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStart": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStartCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTransitionEnd": { + "type": "TransitionEventHandler", + "required": false + }, + "onTransitionEndCapture": { + "type": "TransitionEventHandler", + "required": false + }, + "onUpdate": { + "type": "(latest: ResolvedValues) => void", + "required": false, + "description": "Callback with latest motion values, fired max once per frame.\n\n```jsx\nfunction onUpdate(latest) {\n console.log(latest.x, latest.opacity)\n}\n\n\n```" + }, + "onViewportEnter": { "type": "ViewportEventHandler", "required": false }, + "onViewportLeave": { "type": "ViewportEventHandler", "required": false }, + "onVolumeChange": { + "type": "ReactEventHandler", + "required": false + }, + "onVolumeChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWaiting": { + "type": "ReactEventHandler", + "required": false + }, + "onWaitingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWheel": { + "type": "WheelEventHandler", + "required": false + }, + "onWheelCapture": { + "type": "WheelEventHandler", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "prefix": { "type": "string", "required": false }, + "property": { "type": "string", "required": false }, + "radioGroup": { "type": "string", "required": false }, + "rel": { "type": "string", "required": false }, + "resource": { "type": "string", "required": false }, + "results": { "type": "number", "required": false }, + "rev": { "type": "string", "required": false }, + "role": { "type": "AriaRole", "required": false }, + "security": { "type": "string", "required": false }, + "slot": { "type": "string", "required": false }, + "spellCheck": { "type": "Booleanish", "required": false }, + "style": { + "type": "MotionStyle", + "required": false, + "description": "\nThe React DOM `style` prop, enhanced with support for `MotionValue`s and separate `transform` values.\n\n```jsx\nexport const MyComponent = () => {\n const x = useMotionValue(0)\n\n return \n}\n```" + }, + "suppressContentEditableWarning": { "type": "boolean", "required": false }, + "suppressHydrationWarning": { "type": "boolean", "required": false }, + "tabIndex": { "type": "number", "required": false }, + "title": { "type": "string", "required": false }, + "transformTemplate": { + "type": "(\n transform: TransformProperties,\n generatedTransform: string\n) => string", + "required": false, + "description": "By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate`\ncan be used to create a different order, or to append/preprend the automatically generated `transform` property.\n\n```jsx\n `rotate(${rotate}deg) translateX(${x}px)`\n }\n/>\n```" + }, + "transformValues": { + "type": "(values: V) => V", + "required": false, + "description": "Internal.\n\nThis allows values to be transformed before being animated or set as styles.\n\nFor instance, this allows custom values in Framer Library like `size` to be converted into `width` and `height`.\nIt also allows us a chance to take a value like `Color` and convert it to an animatable color string.\n\nA few structural typing changes need making before this can be a public property:\n- Allow `Target` values to be appended by user-defined types (delete `CustomStyles` - does `size` throw a type error?)\n- Extract `CustomValueType` as a separate user-defined type (delete `CustomValueType` and animate a `Color` - does this throw a type error?)." + }, + "translate": { "type": "\"yes\" | \"no\"", "required": false }, + "typeof": { "type": "string", "required": false }, + "unselectable": { "type": "\"on\" | \"off\"", "required": false }, + "variants": { + "type": "Variants", + "required": false, + "description": "Variants allow you to define animation states and organise them by name. They allow\nyou to control animations throughout a component tree by switching a single `animate` prop.\n\nUsing `transition` options like `delayChildren` and `staggerChildren`, you can orchestrate\nwhen children animations play relative to their parent.\n\n\nAfter passing variants to one or more `motion` component's `variants` prop, these variants\ncan be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n\n```jsx\nconst variants = {\n active: {\n backgroundColor: \"#f00\"\n },\n inactive: {\n backgroundColor: \"#fff\",\n transition: { duration: 2 }\n }\n}\n\n\n```" + }, + "viewport": { "type": "ViewportOptions", "required": false }, + "vocab": { "type": "string", "required": false }, + "whileDrag": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the drag gesture is recognised.\n\n```jsx\n\n```" + }, + "whileFocus": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the focus gesture is recognised.\n\n```jsx\n\n```" + }, + "whileHover": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the hover gesture is recognised.\n\n```jsx\n\n```" + }, + "whileInView": { + "type": "TargetAndTransition | VariantLabels", + "required": false + }, + "whileTap": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the component is pressed.\n\n```jsx\n\n```" + } + }, + "AsideOptions": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "errorComponent": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "isLoading": { "type": "boolean", "required": false }, + "skeleton": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "Aside": { + "_dragX": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "_dragY": { + "type": "MotionValue", + "required": false, + "description": "Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement.\nPassing MotionValues as _dragX and _dragY instead applies drag updates to these motion values.\nThis allows you to manually control how updates from a drag gesture on an element is applied." + }, + "about": { "type": "string", "required": false }, + "accessKey": { "type": "string", "required": false }, + "animate": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | AnimationControls\n | TargetAndTransition\n | VariantLabels", + "required": false, + "description": "Values to animate to, variant label(s), or `AnimationControls`.\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// AnimationControls\n\n```" + }, + "aria-activedescendant": { "type": "string", "required": false }, + "aria-atomic": { "type": "Booleanish", "required": false }, + "aria-autocomplete": { + "type": "\"none\" | \"list\" | \"inline\" | \"both\"", + "required": false + }, + "aria-braillelabel": { "type": "string", "required": false }, + "aria-brailleroledescription": { "type": "string", "required": false }, + "aria-busy": { "type": "Booleanish", "required": false }, + "aria-checked": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-colcount": { "type": "number", "required": false }, + "aria-colindex": { "type": "number", "required": false }, + "aria-colindextext": { "type": "string", "required": false }, + "aria-colspan": { "type": "number", "required": false }, + "aria-controls": { "type": "string", "required": false }, + "aria-current": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"time\"\n | \"page\"\n | \"true\"\n | \"false\"\n | \"step\"\n | \"location\"\n | \"date\"", + "required": false + }, + "aria-describedby": { "type": "string", "required": false }, + "aria-description": { "type": "string", "required": false }, + "aria-details": { "type": "string", "required": false }, + "aria-disabled": { "type": "Booleanish", "required": false }, + "aria-dropeffect": { + "type": "\"link\" | \"none\" | \"copy\" | \"move\" | \"execute\" | \"popup\"", + "required": false + }, + "aria-errormessage": { "type": "string", "required": false }, + "aria-expanded": { "type": "Booleanish", "required": false }, + "aria-flowto": { "type": "string", "required": false }, + "aria-grabbed": { "type": "Booleanish", "required": false }, + "aria-haspopup": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | \"dialog\"\n | \"menu\"\n | \"grid\"\n | \"true\"\n | \"false\"\n | \"listbox\"\n | \"tree\"", + "required": false + }, + "aria-hidden": { "type": "Booleanish", "required": false }, + "aria-invalid": { + "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", + "required": false + }, + "aria-keyshortcuts": { "type": "string", "required": false }, + "aria-label": { "type": "string", "required": false }, + "aria-labelledby": { "type": "string", "required": false }, + "aria-level": { "type": "number", "required": false }, + "aria-live": { + "type": "\"off\" | \"assertive\" | \"polite\"", + "required": false + }, + "aria-modal": { "type": "Booleanish", "required": false }, + "aria-multiline": { "type": "Booleanish", "required": false }, + "aria-multiselectable": { "type": "Booleanish", "required": false }, + "aria-orientation": { + "type": "\"vertical\" | \"horizontal\"", + "required": false + }, + "aria-owns": { "type": "string", "required": false }, + "aria-placeholder": { "type": "string", "required": false }, + "aria-posinset": { "type": "number", "required": false }, + "aria-pressed": { + "type": "boolean | \"true\" | \"false\" | \"mixed\"", + "required": false + }, + "aria-readonly": { "type": "Booleanish", "required": false }, + "aria-relevant": { + "type": "type ONLY_FOR_FORMAT =\n | \"text\"\n | \"all\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", + "required": false + }, + "aria-required": { "type": "Booleanish", "required": false }, + "aria-roledescription": { "type": "string", "required": false }, + "aria-rowcount": { "type": "number", "required": false }, + "aria-rowindex": { "type": "number", "required": false }, + "aria-rowindextext": { "type": "string", "required": false }, + "aria-rowspan": { "type": "number", "required": false }, + "aria-selected": { "type": "Booleanish", "required": false }, + "aria-setsize": { "type": "number", "required": false }, + "aria-sort": { + "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", + "required": false + }, + "aria-valuemax": { "type": "number", "required": false }, + "aria-valuemin": { "type": "number", "required": false }, + "aria-valuenow": { "type": "number", "required": false }, + "aria-valuetext": { "type": "string", "required": false }, + "autoCapitalize": { "type": "string", "required": false }, + "autoCorrect": { "type": "string", "required": false }, + "autoFocus": { "type": "boolean", "required": false }, + "autoSave": { "type": "string", "required": false }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "className": { "type": "string", "required": false }, + "content": { "type": "string", "required": false }, + "contentEditable": { + "type": "\"inherit\" | Booleanish", + "required": false + }, + "contextMenu": { "type": "string", "required": false }, + "custom": { + "type": "any", + "required": false, + "description": "Custom data to use to resolve dynamic variants differently for each animating component.\n\n```jsx\nconst variants = {\n visible: (custom) => ({\n opacity: 1,\n transition: { delay: custom * 0.2 }\n })\n}\n\n\n\n\n```" + }, + "dangerouslySetInnerHTML": { + "type": "{ __html: string | TrustedHTML }", + "required": false + }, + "datatype": { "type": "string", "required": false }, + "defaultChecked": { "type": "boolean", "required": false }, + "defaultValue": { + "type": "string | number | readonly string[]", + "required": false + }, + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "dir": { "type": "string", "required": false }, + "drag": { + "type": "boolean | \"x\" | \"y\"", + "required": false, + "description": "Enable dragging for this element. Set to `false` by default.\nSet `true` to drag in both directions.\nSet `\"x\"` or `\"y\"` to only drag in a specific direction.\n\n```jsx\n\n```" + }, + "dragConstraints": { + "type": "false | Partial | RefObject", + "required": false, + "description": "Applies constraints on the permitted draggable area.\n\nIt can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels.\nThis will define a distance the named edge of the draggable component.\n\nAlternatively, it can accept a `ref` to another component created with React's `useRef` hook.\nThis `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref`\nof the component you want to use as constraints.\n\n```jsx\n// In pixels\n\n\n// As a ref to another component\nconst MyComponent = () => {\n const constraintsRef = useRef(null)\n\n return (\n \n \n \n )\n}\n```" + }, + "dragControls": { + "type": "DragControls", + "required": false, + "description": "Usually, dragging is initiated by pressing down on a component and moving it. For some\nuse-cases, for instance clicking at an arbitrary point on a video scrubber, we\nmight want to initiate dragging from a different component than the draggable one.\n\nBy creating a `dragControls` using the `useDragControls` hook, we can pass this into\nthe draggable component's `dragControls` prop. It exposes a `start` method\nthat can start dragging from pointer events on other components.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragDirectionLock": { + "type": "boolean", + "required": false, + "description": "If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n\n```jsx\n\n```" + }, + "dragElastic": { + "type": "DragElastic", + "required": false, + "description": "The degree of movement allowed outside constraints. 0 = no movement, 1 =\nfull movement.\n\nSet to `0.5` by default. Can also be set as `false` to disable movement.\n\nBy passing an object of `top`/`right`/`bottom`/`left`, individual values can be set\nper constraint. Any missing values will be set to `0`.\n\n```jsx\n\n```" + }, + "draggable": { "type": "Booleanish", "required": false }, + "dragListener": { + "type": "boolean", + "required": false, + "description": "By default, if `drag` is defined on a component then an event listener will be attached\nto automatically initiate dragging when a user presses down on it.\n\nBy setting `dragListener` to `false`, this event listener will not be created.\n\n```jsx\nconst dragControls = useDragControls()\n\nfunction startDrag(event) {\n dragControls.start(event, { snapToCursor: true })\n}\n\nreturn (\n <>\n
\n \n \n)\n```" + }, + "dragMomentum": { + "type": "boolean", + "required": false, + "description": "Apply momentum from the pan gesture to the component when dragging\nfinishes. Set to `true` by default.\n\n```jsx\n\n```" + }, + "dragPropagation": { + "type": "boolean", + "required": false, + "description": "Allows drag gesture propagation to child components. Set to `false` by\ndefault.\n\n```jsx\n\n```" + }, + "dragSnapToOrigin": { + "type": "boolean", + "required": false, + "description": "If true, element will snap back to its origin when dragging ends.\n\nEnabling this is the equivalent of setting all `dragConstraints` axes to `0`\nwith `dragElastic={1}`, but when used together `dragConstraints` can define\na wider draggable area and `dragSnapToOrigin` will ensure the element\nanimates back to its origin on release." + }, + "dragTransition": { + "type": "Partial>", + "required": false, + "description": "Allows you to change dragging inertia parameters.\nWhen releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it.\nSee \n{@link \nhttps://framer.com/api/animation/#inertia Inertia\n}\n for all properties you can use.\n\n```jsx\n\n```" + }, + "errorComponent": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "exit": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "A target to animate to when this component is removed from the tree.\n\nThis component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n\nThis limitation exists because React doesn't allow components to defer unmounting until after\nan animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n\n```jsx\nimport { AnimatePresence, motion } from 'framer-motion'\n\nexport const MyComponent = ({ isVisible }) => {\n return (\n \n {isVisible && (\n \n )}\n \n )\n}\n```" + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "hidden": { "type": "boolean", "required": false }, + "id": { "type": "string", "required": false }, + "ignoreStrict": { "type": "boolean", "required": false }, + "inherit": { "type": "boolean", "required": false }, + "initial": { + "type": "type ONLY_FOR_FORMAT =\n | boolean\n | MakeCustomValueType\n | VariantLabels", + "required": false, + "description": "Properties, variant label or array of variant labels to start in.\n\nSet to `false` to initialise with the values in `animate` (disabling the mount animation)\n\n```jsx\n// As values\n\n\n// As variant\n\n\n// Multiple variants\n\n\n// As false (disable mount animation)\n\n```" + }, + "inlist": { "type": "any", "required": false }, + "inputMode": { + "type": "type ONLY_FOR_FORMAT =\n | \"search\"\n | \"text\"\n | \"none\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"", + "required": false + }, + "is": { "type": "string", "required": false }, + "isLoading": { "type": "boolean", "required": false }, + "isOpen": { "type": "boolean", "required": false }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "itemID": { "type": "string", "required": false }, + "itemProp": { "type": "string", "required": false }, + "itemRef": { "type": "string", "required": false }, + "itemScope": { "type": "boolean", "required": false }, + "itemType": { "type": "string", "required": false }, + "lang": { "type": "string", "required": false }, + "layout": { + "type": "boolean | \"position\" | \"size\" | \"preserve-aspect\"", + "required": false, + "description": "If `true`, this component will automatically animate to its new position when\nits layout changes.\n\n```jsx\n\n```\n\nThis will perform a layout animation using performant transforms. Part of this technique\ninvolved animating an element's scale. This can introduce visual distortions on children,\n`boxShadow` and `borderRadius`.\n\nTo correct distortion on immediate children, add `layout` to those too.\n\n`boxShadow` and `borderRadius` will automatically be corrected if they are already being\nanimated on this component. Otherwise, set them directly via the `initial` prop.\n\nIf `layout` is set to `\"position\"`, the size of the component will change instantly and\nonly its position will animate. If `layout` is set to `\"size\"`, the position of the\ncomponent will change instantly but its size will animate.\n\nIf `layout` is set to `\"size\"`, the position of the component will change instantly and\nonly its size will animate.\n\nIf `layout` is set to `\"preserve-aspect\"`, the component will animate size & position if\nthe aspect ratio remains the same between renders, and just position if the ratio changes." + }, + "layoutDependency": { "type": "any", "required": false }, + "layoutId": { + "type": "string", + "required": false, + "description": "Enable shared layout transitions between different components with the same `layoutId`.\n\nWhen a component with a layoutId is removed from the React tree, and then\nadded elsewhere, it will visually animate from the previous component's bounding box\nand its latest animated values.\n\n```jsx\n {items.map(item => (\n \n {item.name}\n {item.isSelected && }\n \n ))}\n```\n\nIf the previous component remains in the tree it will crossfade with the new component." + }, + "layoutRoot": { + "type": "boolean", + "required": false, + "description": "Whether an element should be considered a \"layout root\", where\nall children will be forced to resolve relatively to it.\nCurrently used for `position: sticky` elements in Framer." + }, + "layoutScroll": { + "type": "boolean", + "required": false, + "description": "Whether a projection node should measure its scroll when it or its descendants update their layout." + }, + "nonce": { "type": "string", "required": false }, + "onAbort": { + "type": "ReactEventHandler", + "required": false + }, + "onAbortCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onAnimationComplete": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` is complete.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has completed.\n\n```jsx\nfunction onComplete() {\n console.log(\"Animation completed\")\n}\n\n {\n console.log('Completed animating', definition)\n }}\n/>\n```" + }, + "onAnimationEnd": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationEndCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIteration": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationIterationCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onAnimationStartCapture": { + "type": "AnimationEventHandler", + "required": false + }, + "onAuxClick": { + "type": "MouseEventHandler", + "required": false + }, + "onAuxClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onBeforeInput": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onBeforeLayoutMeasure": { + "type": "(box: Box) => void", + "required": false + }, + "onBlur": { + "type": "FocusEventHandler", + "required": false + }, + "onBlurCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onCanPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThrough": { + "type": "ReactEventHandler", + "required": false + }, + "onCanPlayThroughCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onChange": { + "type": "FormEventHandler", + "required": false + }, + "onChangeCapture": { + "type": "FormEventHandler", + "required": false + }, + "onClick": { + "type": "MouseEventHandler", + "required": false + }, + "onClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCompositionEnd": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionEndCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStart": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionStartCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdate": { + "type": "CompositionEventHandler", + "required": false + }, + "onCompositionUpdateCapture": { + "type": "CompositionEventHandler", + "required": false + }, + "onContextMenu": { + "type": "MouseEventHandler", + "required": false + }, + "onContextMenuCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onCopy": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCopyCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCut": { + "type": "ClipboardEventHandler", + "required": false + }, + "onCutCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onDirectionLock": { + "type": "(axis: \"x\" | \"y\") => void", + "required": false, + "description": "Callback function that fires a drag direction is determined.\n\n```jsx\n console.log(axis)}\n/>\n```" + }, + "onDoubleClick": { + "type": "MouseEventHandler", + "required": false + }, + "onDoubleClickCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEndCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnter": { + "type": "DragEventHandler", + "required": false + }, + "onDragEnterCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragExit": { + "type": "DragEventHandler", + "required": false + }, + "onDragExitCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeave": { + "type": "DragEventHandler", + "required": false + }, + "onDragLeaveCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragOver": { + "type": "DragEventHandler", + "required": false + }, + "onDragOverCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStartCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDragTransitionEnd": { + "type": "() => void", + "required": false, + "description": "Callback function that fires when drag momentum/bounce transition finishes.\n\n```jsx\n console.log('Drag transition complete')}\n/>\n```" + }, + "onDrop": { "type": "DragEventHandler", "required": false }, + "onDropCapture": { + "type": "DragEventHandler", + "required": false + }, + "onDurationChange": { + "type": "ReactEventHandler", + "required": false + }, + "onDurationChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptied": { + "type": "ReactEventHandler", + "required": false + }, + "onEmptiedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEncrypted": { + "type": "ReactEventHandler", + "required": false + }, + "onEncryptedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onEnded": { + "type": "ReactEventHandler", + "required": false + }, + "onEndedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onError": { + "type": "ReactEventHandler", + "required": false + }, + "onErrorCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onFocus": { + "type": "FocusEventHandler", + "required": false + }, + "onFocusCapture": { + "type": "FocusEventHandler", + "required": false + }, + "onGotPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onGotPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onHoverEnd": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer stops hovering over the component.\n\n```jsx\n console.log(\"Hover ends\")} />\n```" + }, + "onHoverStart": { + "type": "(event: MouseEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when pointer starts hovering over the component.\n\n```jsx\n console.log('Hover starts')} />\n```" + }, + "onInput": { + "type": "FormEventHandler", + "required": false + }, + "onInputCapture": { + "type": "FormEventHandler", + "required": false + }, + "onInvalid": { + "type": "FormEventHandler", + "required": false + }, + "onInvalidCapture": { + "type": "FormEventHandler", + "required": false + }, + "onKeyDown": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyDownCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPress": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyPressCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUp": { + "type": "KeyboardEventHandler", + "required": false + }, + "onKeyUpCapture": { + "type": "KeyboardEventHandler", + "required": false + }, + "onLayoutAnimationComplete": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component completes." + }, + "onLayoutAnimationStart": { + "type": "() => void", + "required": false, + "description": "A callback that will fire when a layout animation on this component starts." + }, + "onLayoutMeasure": { + "type": "(box: Box, prevBox: Box) => void", + "required": false + }, + "onLoad": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedData": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedDataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadata": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadedMetadataCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStart": { + "type": "ReactEventHandler", + "required": false + }, + "onLoadStartCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onLostPointerCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onLostPointerCaptureCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onMeasureDragConstraints": { + "type": "(constraints: BoundingBox) => void | BoundingBox", + "required": false, + "description": "If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints." + }, + "onMouseDown": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseDownCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseEnter": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseLeave": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMove": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseMoveCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOut": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOutCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOver": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseOverCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUp": { + "type": "MouseEventHandler", + "required": false + }, + "onMouseUpCapture": { + "type": "MouseEventHandler", + "required": false + }, + "onPan": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture is recognised on this element.\n\n**Note:** For pan gestures to work correctly with touch input, the element needs\ntouch scrolling to be disabled on either x/y or both axis with the\n[touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) CSS rule.\n\n```jsx\nfunction onPan(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanEnd": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture ends on this element.\n\n```jsx\nfunction onPanEnd(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanSessionStart": { + "type": "(event: PointerEvent, info: EventInfo) => void", + "required": false, + "description": "Callback function that fires when we begin detecting a pan gesture. This\nis analogous to `onMouseStart` or `onTouchStart`.\n\n```jsx\nfunction onPanSessionStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPanStart": { + "type": "(event: PointerEvent, info: PanInfo) => void", + "required": false, + "description": "Callback function that fires when the pan gesture begins on this element.\n\n```jsx\nfunction onPanStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onPaste": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPasteCapture": { + "type": "ClipboardEventHandler", + "required": false + }, + "onPause": { + "type": "ReactEventHandler", + "required": false + }, + "onPauseCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlay": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPlaying": { + "type": "ReactEventHandler", + "required": false + }, + "onPlayingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onPointerCancel": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerCancelCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDown": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerDownCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnter": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerEnterCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeave": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerLeaveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMove": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerMoveCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOut": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOutCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOver": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerOverCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUp": { + "type": "PointerEventHandler", + "required": false + }, + "onPointerUpCapture": { + "type": "PointerEventHandler", + "required": false + }, + "onProgress": { + "type": "ReactEventHandler", + "required": false + }, + "onProgressCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChange": { + "type": "ReactEventHandler", + "required": false + }, + "onRateChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onReset": { + "type": "FormEventHandler", + "required": false + }, + "onResetCapture": { + "type": "FormEventHandler", + "required": false + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + }, + "onResizeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onScroll": { "type": "UIEventHandler", "required": false }, + "onScrollCapture": { + "type": "UIEventHandler", + "required": false + }, + "onSeeked": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekedCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSeeking": { + "type": "ReactEventHandler", + "required": false + }, + "onSeekingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSelect": { + "type": "ReactEventHandler", + "required": false + }, + "onSelectCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onStalled": { + "type": "ReactEventHandler", + "required": false + }, + "onStalledCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onSubmit": { + "type": "FormEventHandler", + "required": false + }, + "onSubmitCapture": { + "type": "FormEventHandler", + "required": false + }, + "onSuspend": { + "type": "ReactEventHandler", + "required": false + }, + "onSuspendCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTap": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture successfully ends on this element.\n\n```jsx\nfunction onTap(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapCancel": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture ends outside this element.\n\n```jsx\nfunction onTapCancel(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTapStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: TapInfo\n) => void", + "required": false, + "description": "Callback when the tap gesture starts on this element.\n\n```jsx\nfunction onTapStart(event, info) {\n console.log(info.point.x, info.point.y)\n}\n\n\n```" + }, + "onTimeUpdate": { + "type": "ReactEventHandler", + "required": false + }, + "onTimeUpdateCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onTouchCancel": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchCancelCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEnd": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchEndCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMove": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchMoveCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStart": { + "type": "TouchEventHandler", + "required": false + }, + "onTouchStartCapture": { + "type": "TouchEventHandler", + "required": false + }, + "onTransitionEnd": { + "type": "TransitionEventHandler", + "required": false + }, + "onTransitionEndCapture": { + "type": "TransitionEventHandler", + "required": false + }, + "onUpdate": { + "type": "(latest: ResolvedValues) => void", + "required": false, + "description": "Callback with latest motion values, fired max once per frame.\n\n```jsx\nfunction onUpdate(latest) {\n console.log(latest.x, latest.opacity)\n}\n\n\n```" + }, + "onViewportEnter": { "type": "ViewportEventHandler", "required": false }, + "onViewportLeave": { "type": "ViewportEventHandler", "required": false }, + "onVolumeChange": { + "type": "ReactEventHandler", + "required": false + }, + "onVolumeChangeCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWaiting": { + "type": "ReactEventHandler", + "required": false + }, + "onWaitingCapture": { + "type": "ReactEventHandler", + "required": false + }, + "onWheel": { + "type": "WheelEventHandler", + "required": false + }, + "onWheelCapture": { + "type": "WheelEventHandler", + "required": false + }, + "placeholder": { "type": "string", "required": false }, + "prefix": { "type": "string", "required": false }, + "property": { "type": "string", "required": false }, + "radioGroup": { "type": "string", "required": false }, + "rel": { "type": "string", "required": false }, + "resource": { "type": "string", "required": false }, + "results": { "type": "number", "required": false }, + "rev": { "type": "string", "required": false }, + "role": { "type": "AriaRole", "required": false }, + "security": { "type": "string", "required": false }, + "skeleton": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "slot": { "type": "string", "required": false }, + "spellCheck": { "type": "Booleanish", "required": false }, + "style": { + "type": "MotionStyle", + "required": false, + "description": "\nThe React DOM `style` prop, enhanced with support for `MotionValue`s and separate `transform` values.\n\n```jsx\nexport const MyComponent = () => {\n const x = useMotionValue(0)\n\n return \n}\n```" + }, + "suppressContentEditableWarning": { "type": "boolean", "required": false }, + "suppressHydrationWarning": { "type": "boolean", "required": false }, + "tabIndex": { "type": "number", "required": false }, + "transformTemplate": { + "type": "(\n transform: TransformProperties,\n generatedTransform: string\n) => string", + "required": false, + "description": "By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate`\ncan be used to create a different order, or to append/preprend the automatically generated `transform` property.\n\n```jsx\n `rotate(${rotate}deg) translateX(${x}px)`\n }\n/>\n```" + }, + "transformValues": { + "type": "(values: V) => V", + "required": false, + "description": "Internal.\n\nThis allows values to be transformed before being animated or set as styles.\n\nFor instance, this allows custom values in Framer Library like `size` to be converted into `width` and `height`.\nIt also allows us a chance to take a value like `Color` and convert it to an animatable color string.\n\nA few structural typing changes need making before this can be a public property:\n- Allow `Target` values to be appended by user-defined types (delete `CustomStyles` - does `size` throw a type error?)\n- Extract `CustomValueType` as a separate user-defined type (delete `CustomValueType` and animate a `Color` - does this throw a type error?)." + }, + "translate": { "type": "\"yes\" | \"no\"", "required": false }, + "typeof": { "type": "string", "required": false }, + "unselectable": { "type": "\"on\" | \"off\"", "required": false }, + "variants": { + "type": "Variants", + "required": false, + "description": "Variants allow you to define animation states and organise them by name. They allow\nyou to control animations throughout a component tree by switching a single `animate` prop.\n\nUsing `transition` options like `delayChildren` and `staggerChildren`, you can orchestrate\nwhen children animations play relative to their parent.\n\n\nAfter passing variants to one or more `motion` component's `variants` prop, these variants\ncan be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n\n```jsx\nconst variants = {\n active: {\n backgroundColor: \"#f00\"\n },\n inactive: {\n backgroundColor: \"#fff\",\n transition: { duration: 2 }\n }\n}\n\n\n```" + }, + "viewport": { "type": "ViewportOptions", "required": false }, + "vocab": { "type": "string", "required": false }, + "whileDrag": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the drag gesture is recognised.\n\n```jsx\n\n```" + }, + "whileFocus": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the focus gesture is recognised.\n\n```jsx\n\n```" + }, + "whileHover": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the hover gesture is recognised.\n\n```jsx\n\n```" + }, + "whileInView": { + "type": "TargetAndTransition | VariantLabels", + "required": false + }, + "whileTap": { + "type": "TargetAndTransition | VariantLabels", + "required": false, + "description": "Properties or variant label to animate to while the component is pressed.\n\n```jsx\n\n```" + } + } +} diff --git a/tooling/props-docs/dist/components/PasswordForm.json b/tooling/props-docs/dist/components/PasswordForm.json new file mode 100644 index 000000000..1b615adb8 --- /dev/null +++ b/tooling/props-docs/dist/components/PasswordForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"PasswordForm","methods":[],"props":{"submitLabel":{"defaultValue":{"value":"Log in"},"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"}],"required":false,"type":{"name":"string"}},"emailLabel":{"defaultValue":{"value":"Email"},"description":"","name":"emailLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"}],"required":false,"type":{"name":"string"}},"passwordLabel":{"defaultValue":{"value":"Password"},"description":"","name":"passwordLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/password-form.tsx","name":"PasswordFormProps"}],"required":false,"type":{"name":"string"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PasswordInput.json b/tooling/props-docs/dist/components/PasswordInput.json new file mode 100644 index 000000000..2a6639a29 --- /dev/null +++ b/tooling/props-docs/dist/components/PasswordInput.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"PasswordInput","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"viewIcon":{"defaultValue":null,"description":"","name":"viewIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"viewOffIcon":{"defaultValue":null,"description":"","name":"viewOffIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"leftAddon":{"defaultValue":null,"description":"","name":"leftAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/password-input/password-input.tsx","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PasswordInputField.json b/tooling/props-docs/dist/components/PasswordInputField.json new file mode 100644 index 000000000..4ce9da7ee --- /dev/null +++ b/tooling/props-docs/dist/components/PasswordInputField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"PasswordInputField","methods":[],"props":{"viewIcon":{"defaultValue":null,"description":"","name":"viewIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"viewOffIcon":{"defaultValue":null,"description":"","name":"viewOffIcon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"leftAddon":{"defaultValue":null,"description":"","name":"leftAddon","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PasswordOptions"}],"required":false,"type":{"name":"ReactNode"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Persona.json b/tooling/props-docs/dist/components/Persona.json new file mode 100644 index 000000000..f6ed3dae8 --- /dev/null +++ b/tooling/props-docs/dist/components/Persona.json @@ -0,0 +1,108 @@ +{ + "Persona": { + "badgeSize": { + "type": "ResponsiveValue", + "required": false, + "description": "The badge size. Defaults to 1em. Use em value to keep the size relative to the avatar." + }, + "crossOrigin": { + "type": "\"\" | \"anonymous\" | \"use-credentials\"", + "required": false + }, + "getInitials": { + "type": "(name: string) => string", + "required": false, + "description": "Function to get the initials to display" + }, + "hideDetails": { + "type": "boolean", + "required": false, + "description": "Hide the persona details next to the avatar." + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The default avatar used as fallback when `name`, and `src`\nis not specified." + }, + "iconLabel": { "type": "string", "required": false }, + "ignoreFallback": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, opt out of the avatar's `fallback` logic and\nrenders the `img` at all times." + }, + "isOutOfOffice": { + "type": "boolean", + "required": false, + "description": "Indicates that a person is out of office. Changes the presence badge style." + }, + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Primary label of the persona, defaults to the name" + }, + "loading": { + "type": "\"eager\" | \"lazy\"", + "required": false, + "description": "Defines loading strategy" + }, + "name": { + "type": "string", + "required": false, + "description": "The name of the person in the avatar.\n\n- if `src` has loaded, the name will be used as the `alt` attribute of the `img`\n- If `src` is not loaded, the name will be used to create the initials" + }, + "onError": { + "type": "() => void", + "required": false, + "description": "Function called when image failed to load" + }, + "presence": { + "type": "string", + "required": false, + "description": "The presence status of the person\n\nIf set will add an AvatarBadge with color configured in `Presence`\nDefault presence options:\n- online\n- offline\n- busy\n- dnd\n- away" + }, + "presenceIcon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The icon shown in the AvatarBadge" + }, + "presenceLabel": { + "type": "string", + "required": false, + "description": "The textual presence status of the person.\nOnline, Offline, Busy, Do-not-disturb or Away" + }, + "referrerPolicy": { + "type": "HTMLAttributeReferrerPolicy", + "required": false, + "description": "Defining which referrer is sent when fetching the resource." + }, + "secondaryLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Secondary label, usually the role of the person\nOnly visible from md size and up." + }, + "showBorder": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the `Avatar` will show a border around it.\n\nBest for a group of avatars" + }, + "src": { + "type": "string", + "required": false, + "description": "The image url of the `Avatar`" + }, + "srcSet": { + "type": "string", + "required": false, + "description": "List of sources to use for different screen resolutions" + }, + "tertiaryLabel": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Tertiary label, usually the status of the person.\nOnly visible from lg size and up." + } + }, + "PersonaContainer": {}, + "PresenceOptions": {} +} diff --git a/tooling/props-docs/dist/components/PersonaAvatar.json b/tooling/props-docs/dist/components/PersonaAvatar.json new file mode 100644 index 000000000..cec2a1a2a --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaAvatar.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"An avatar with optional status badge.","displayName":"PersonaAvatar","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"name":{"defaultValue":null,"description":"The name of the person in the avatar.\n\n- if `src` has loaded, the name will be used as the `alt` attribute of the `img`\n- If `src` is not loaded, the name will be used to create the initials","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"string"}},"presence":{"defaultValue":null,"description":"The presence status of the person\n\nIf set will add an AvatarBadge with color configured in `Presence`\nDefault presence options:\n- online\n- offline\n- busy\n- dnd\n- away","name":"presence","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"string"}},"presenceLabel":{"defaultValue":null,"description":"The textual presence status of the person.\nOnline, Offline, Busy, Do-not-disturb or Away","name":"presenceLabel","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"string"}},"presenceIcon":{"defaultValue":null,"description":"The icon shown in the AvatarBadge","name":"presenceIcon","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"ReactNode"}},"badgeSize":{"defaultValue":null,"description":"The badge size. Defaults to 1em. Use em value to keep the size relative to the avatar.","name":"badgeSize","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"ResponsiveValue"}},"isOutOfOffice":{"defaultValue":null,"description":"Indicates that a person is out of office. Changes the presence badge style.","name":"isOutOfOffice","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PersonaContainer.json b/tooling/props-docs/dist/components/PersonaContainer.json new file mode 100644 index 000000000..ec4836376 --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaContainer.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The container component that provides context and styles.","displayName":"PersonaContainer","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PersonaDetails.json b/tooling/props-docs/dist/components/PersonaDetails.json new file mode 100644 index 000000000..c819c95d4 --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaDetails.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"Wrapper component for the labels.","displayName":"PersonaDetails","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"name":{"defaultValue":null,"description":"The name of the person in the avatar.\n\n- if `src` has loaded, the name will be used as the `alt` attribute of the `img`\n- If `src` is not loaded, the name will be used to create the initials","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"string"}},"presence":{"defaultValue":null,"description":"The presence status of the person\n\nIf set will add an AvatarBadge with color configured in `Presence`\nDefault presence options:\n- online\n- offline\n- busy\n- dnd\n- away","name":"presence","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"string"}},"presenceIcon":{"defaultValue":null,"description":"The icon shown in the AvatarBadge","name":"presenceIcon","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"ReactNode"}},"isOutOfOffice":{"defaultValue":null,"description":"Indicates that a person is out of office. Changes the presence badge style.","name":"isOutOfOffice","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"boolean"}},"label":{"defaultValue":null,"description":"Primary label of the persona, defaults to the name","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"ReactNode"}},"secondaryLabel":{"defaultValue":null,"description":"Secondary label, usually the role of the person\nOnly visible from md size and up.","name":"secondaryLabel","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"ReactNode"}},"tertiaryLabel":{"defaultValue":null,"description":"Tertiary label, usually the status of the person.\nOnly visible from lg size and up.","name":"tertiaryLabel","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"ReactNode"}},"hideDetails":{"defaultValue":null,"description":"Hide the persona details next to the avatar.","name":"hideDetails","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PersonaOptions"}],"required":false,"type":{"name":"boolean"}},"presenceLabel":{"defaultValue":null,"description":"The textual presence status of the person.\nOnline, Offline, Busy, Do-not-disturb or Away","name":"presenceLabel","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"string"}},"badgeSize":{"defaultValue":null,"description":"The badge size. Defaults to 1em. Use em value to keep the size relative to the avatar.","name":"badgeSize","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/persona/persona.tsx","name":"PresenceAvatarOptions"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PersonaLabel.json b/tooling/props-docs/dist/components/PersonaLabel.json new file mode 100644 index 000000000..f5f5a3c99 --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaLabel.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The main label, usually a name.","displayName":"PersonaLabel","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PersonaSecondaryLabel.json b/tooling/props-docs/dist/components/PersonaSecondaryLabel.json new file mode 100644 index 000000000..4bd778aa0 --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaSecondaryLabel.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The secondary label, usually the role of a person.","displayName":"PersonaSecondaryLabel","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PersonaTertiaryLabel.json b/tooling/props-docs/dist/components/PersonaTertiaryLabel.json new file mode 100644 index 000000000..d194eb7c1 --- /dev/null +++ b/tooling/props-docs/dist/components/PersonaTertiaryLabel.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/persona"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The tertiary label, typically a status message.","displayName":"PersonaTertiaryLabel","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PinField.json b/tooling/props-docs/dist/components/PinField.json new file mode 100644 index 000000000..089164a7e --- /dev/null +++ b/tooling/props-docs/dist/components/PinField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"PinField","methods":[],"props":{"pinLength":{"defaultValue":null,"description":"","name":"pinLength","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"number"}},"pinType":{"defaultValue":null,"description":"","name":"pinType","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"\"number\" | \"alphanumeric\""}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"PinFieldProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":true,"type":{"name":"string"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PinInput.json b/tooling/props-docs/dist/components/PinInput.json new file mode 100644 index 000000000..6e1f78d31 --- /dev/null +++ b/tooling/props-docs/dist/components/PinInput.json @@ -0,0 +1 @@ +{"tags":{"deprecated":""},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/pin-input/index.ts","description":"","displayName":"PinInput","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"pinLength":{"defaultValue":{"value":4},"description":"The pin length.","name":"pinLength","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/pin-input/pin-input.tsx","name":"PinInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/pin-input/pin-input.tsx","name":"PinInputOptions"}],"required":false,"type":{"name":"number"}},"spacing":{"defaultValue":null,"description":"Spacing between the inputs.","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/pin-input/pin-input.tsx","name":"PinInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/pin-input/pin-input.tsx","name":"PinInputOptions"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PlusIcon.json b/tooling/props-docs/dist/components/PlusIcon.json new file mode 100644 index 000000000..708ae24ff --- /dev/null +++ b/tooling/props-docs/dist/components/PlusIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"PlusIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Property.json b/tooling/props-docs/dist/components/Property.json new file mode 100644 index 000000000..6f38df7fa --- /dev/null +++ b/tooling/props-docs/dist/components/Property.json @@ -0,0 +1,39 @@ +{ + "PropertyLabel": {}, + "PropertyList": { + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between each list item" + }, + "stylePosition": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `listStylePosition`" + }, + "styleType": { + "type": "ResponsiveValue", + "required": false, + "description": "Shorthand prop for `listStyleType`" + } + }, + "Property": { + "label": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "labelWidth": { + "type": "ResponsiveValue", + "required": false + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + }, + "value": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "PropertyValue": {} +} diff --git a/tooling/props-docs/dist/components/PropertyLabel.json b/tooling/props-docs/dist/components/PropertyLabel.json new file mode 100644 index 000000000..32d197882 --- /dev/null +++ b/tooling/props-docs/dist/components/PropertyLabel.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/property"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The property label.","displayName":"PropertyLabel","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"label":{"defaultValue":null,"description":"","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"}],"required":false,"type":{"name":"ReactNode"}},"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"}],"required":false,"type":{"name":"ReactNode"}},"labelWidth":{"defaultValue":null,"description":"","name":"labelWidth","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/property/property.tsx","name":"PropertyOptions"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/PropertyValue.json b/tooling/props-docs/dist/components/PropertyValue.json new file mode 100644 index 000000000..4a691f9e5 --- /dev/null +++ b/tooling/props-docs/dist/components/PropertyValue.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/data-display/property"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"The property value.","displayName":"PropertyValue","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Provider.json b/tooling/props-docs/dist/components/Provider.json new file mode 100644 index 000000000..9be954e70 --- /dev/null +++ b/tooling/props-docs/dist/components/Provider.json @@ -0,0 +1,69 @@ +{ + "SaasProvider": { + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Your application content" + }, + "colorModeManager": { + "type": "StorageManager", + "defaultValue": "localStorageManager", + "required": false, + "description": "manager to persist a users color mode preference in\n\nomit if you don't render server-side\nfor SSR: choose `cookieStorageManager`" + }, + "disableEnvironment": { + "type": "boolean", + "required": false, + "description": "Disabled the use of automatic window and document detection.\nThis removed the injected `` element" + }, + "disableGlobalStyle": { + "type": "boolean", + "required": false, + "description": "If `true`, Chakra will not mount the global styles defined in the theme." + }, + "environment": { + "type": "Environment", + "required": false, + "description": "The environment (`window` and `document`) to be used by\nall components and hooks.\n\nBy default, we smartly determine the ownerDocument and defaultView\nbased on where `ChakraProvider` is rendered." + }, + "linkComponent": { "type": "ElementType", "required": false }, + "onError": { + "type": "(error: Error, errorInfo: ErrorInfo) => void", + "required": false + }, + "portalZIndex": { + "type": "number", + "defaultValue": "undefined", + "required": false, + "description": "Common z-index to use for `Portal`" + }, + "resetCSS": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "If `true`, `CSSReset` component will be mounted to help\nyou reset browser styles" + }, + "resetScope": { + "type": "string", + "required": false, + "description": "The selector to scope the css reset styles to." + }, + "theme": { + "type": "Dict", + "required": false, + "description": "a theme. if omitted, uses the default theme provided by chakra" + }, + "toastOptions": { + "type": "ToastProviderProps", + "required": false, + "description": "Provide defaults for `useToast()` usages for `ChakraProvider`s children" + } + }, + "UseActivePathOptions": { + "end": { + "type": "boolean", + "required": false, + "description": "Set to false to match the first parth of the path.\neg: /contacts will match /contacts/people" + } + } +} diff --git a/tooling/props-docs/dist/components/Providers.json b/tooling/props-docs/dist/components/Providers.json new file mode 100644 index 000000000..e8e65e771 --- /dev/null +++ b/tooling/props-docs/dist/components/Providers.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"Providers","methods":[],"props":{"providers":{"defaultValue":null,"description":"The available providers","name":"providers","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"}],"required":true,"type":{"name":"AvailableProviders"}},"labelPrefix":{"defaultValue":{"value":"Continue with"},"description":"The label prefix","name":"labelPrefix","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"}],"required":false,"type":{"name":"string"}},"onSignIn":{"defaultValue":null,"description":"The on sign in callback\n@param providerId The provider id","name":"onSignIn","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/providers.tsx","name":"ProvidersProps"}],"required":true,"type":{"name":"(providerId: Extract) => void"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/RadioField.json b/tooling/props-docs/dist/components/RadioField.json new file mode 100644 index 000000000..de21d6139 --- /dev/null +++ b/tooling/props-docs/dist/components/RadioField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"RadioField","methods":[],"props":{"options":{"defaultValue":null,"description":"","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"}],"required":true,"type":{"name":"RadioOptions"}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"}],"required":false,"type":{"name":"ResponsiveValue"}},"direction":{"defaultValue":null,"description":"","name":"direction","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"RadioInputOptions"}],"required":false,"type":{"name":"StackDirection"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/RadioInput.json b/tooling/props-docs/dist/components/RadioInput.json new file mode 100644 index 000000000..02cd2a970 --- /dev/null +++ b/tooling/props-docs/dist/components/RadioInput.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"RadioInput","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"options":{"defaultValue":null,"description":"","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"}],"required":true,"type":{"name":"RadioOptions"}},"spacing":{"defaultValue":null,"description":"","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"}],"required":false,"type":{"name":"ResponsiveValue"}},"direction":{"defaultValue":null,"description":"","name":"direction","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/radio/radio-input.tsx","name":"RadioInputOptions"}],"required":false,"type":{"name":"StackDirection"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Resize.json b/tooling/props-docs/dist/components/Resize.json new file mode 100644 index 000000000..65a2df7a4 --- /dev/null +++ b/tooling/props-docs/dist/components/Resize.json @@ -0,0 +1,126 @@ +{ + "ResizeOptions": { + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + } + }, + "UseResize": { + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + } + }, + "ResizeBox": { + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + } + }, + "Resizer": { + "children": { + "type": "ReactElement>", + "required": false + }, + "defaultWidth": { + "type": "number", + "defaultValue": "280", + "required": false, + "description": "The default width." + }, + "handlePosition": { + "type": "\"right\" | \"left\"", + "defaultValue": "'right'", + "required": false, + "description": "The handle position." + }, + "isResizable": { + "type": "boolean", + "defaultValue": true, + "required": false, + "description": "Indicate if resizing is enabled." + }, + "onHandleClick": { + "type": "MouseEventHandler", + "required": false, + "description": "Callback called when the handle is clicked." + }, + "onResize": { + "type": "ResizeHandler", + "required": false, + "description": "Callback called when resizing is finished." + } + } +} diff --git a/tooling/props-docs/dist/components/SaasProvider.json b/tooling/props-docs/dist/components/SaasProvider.json new file mode 100644 index 000000000..670bb08fe --- /dev/null +++ b/tooling/props-docs/dist/components/SaasProvider.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"SaasProvider","methods":[],"props":{"theme":{"defaultValue":null,"description":"a theme. if omitted, uses the default theme provided by chakra","name":"theme","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"}],"required":false,"type":{"name":"any"}},"linkComponent":{"defaultValue":null,"description":"","name":"linkComponent","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"}],"required":false,"type":{"name":"ElementType"}},"children":{"defaultValue":null,"description":"Your application content","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"}],"required":true,"type":{"name":"ReactNode"}},"onError":{"defaultValue":null,"description":"","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SaasProviderProps"}],"required":false,"type":{"name":"((error: Error, errorInfo: ErrorInfo) => void)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SearchIcon.json b/tooling/props-docs/dist/components/SearchIcon.json new file mode 100644 index 000000000..26383bcad --- /dev/null +++ b/tooling/props-docs/dist/components/SearchIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"SearchIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SearchInput.json b/tooling/props-docs/dist/components/SearchInput.json new file mode 100644 index 000000000..4e05ba762 --- /dev/null +++ b/tooling/props-docs/dist/components/SearchInput.json @@ -0,0 +1,69 @@ +{ + "SearchInput": { + "errorBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is invalid. Use color keys in `theme.colors`" + }, + "focusBorderColor": { + "type": "string", + "required": false, + "description": "The border color when the input is focused. Use color keys in `theme.colors`" + }, + "htmlSize": { + "type": "number", + "required": false, + "description": "The native HTML `size` attribute to be passed to the `input`" + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "The icon to render before the input text" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled" + }, + "isInvalid": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be invalid. This has 2 side effects:\n- The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true`\n- The form element (e.g, Input) will have `aria-invalid` set to `true`" + }, + "isReadOnly": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be readonly" + }, + "isRequired": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the form control will be required. This has 2 side effects:\n- The `FormLabel` will show a required indicator\n- The form element (e.g, Input) will have `aria-required` set to `true`" + }, + "onReset": { + "type": "() => void", + "required": false, + "description": "Callback to trigger when the reset button is clicked or escape key is pressed" + }, + "placeholder": { + "type": "string", + "defaultValue": "Search", + "required": false, + "description": "The placeholder text for the input" + }, + "resetIcon": { + "type": "ReactElement>", + "required": false, + "description": "The icon to render in the reset button" + }, + "rightElement": { + "type": "ReactElement>", + "required": false, + "description": "Right element rendered when the value is empty" + } + } +} diff --git a/tooling/props-docs/dist/components/Select.json b/tooling/props-docs/dist/components/Select.json new file mode 100644 index 000000000..f4f0e7438 --- /dev/null +++ b/tooling/props-docs/dist/components/Select.json @@ -0,0 +1 @@ +{"tags":{"see":"https://saas-ui.dev/docs/components/forms/select"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"Allow users to select a value from a list of options.","displayName":"Select","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"name":{"defaultValue":null,"description":"The name of the input field in a native form.","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":true,"type":{"name":"string"}},"value":{"defaultValue":null,"description":"The value of the select field.","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"string | string[]"}},"defaultValue":{"defaultValue":null,"description":"The initial value of the select field.","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"string | string[]"}},"onChange":{"defaultValue":null,"description":"The callback invoked when the value of the select field changes.\n@param value The value of the select field.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"((value: string | string[]) => void)"}},"placeholder":{"defaultValue":null,"description":"The placeholder text when there's no value.","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"string"}},"isDisabled":{"defaultValue":null,"description":"If `true`, the select will be disabled.","name":"isDisabled","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"boolean"}},"options":{"defaultValue":null,"description":"An array of options\nIf you leave this empty the children prop will be rendered.","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"FieldOptions"}},"multiple":{"defaultValue":null,"description":"Enable multiple select.","name":"multiple","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"boolean"}},"renderValue":{"defaultValue":null,"description":"The function used to render the value of the select field.\n@param value The value of the select field.\n@returns The rendered value.","name":"renderValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/select/select-context.tsx","name":"SelectOptions"}],"required":false,"type":{"name":"((value: string | string[]) => ReactNode)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SelectButton.json b/tooling/props-docs/dist/components/SelectButton.json new file mode 100644 index 000000000..79b7a9aec --- /dev/null +++ b/tooling/props-docs/dist/components/SelectButton.json @@ -0,0 +1 @@ +{"tags":{"see":"https://saas-ui.dev/docs/components/forms/select"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"Button that opens the select menu and displays the selected value.","displayName":"SelectButton","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SelectField.json b/tooling/props-docs/dist/components/SelectField.json new file mode 100644 index 000000000..992c2dccd --- /dev/null +++ b/tooling/props-docs/dist/components/SelectField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"SelectField","methods":[],"props":{"name":{"defaultValue":null,"description":"The name of the input field in a native form.\nThe field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":true,"type":{"name":"string"}},"value":{"defaultValue":null,"description":"The value of the select field.","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"string | string[]"}},"defaultValue":{"defaultValue":null,"description":"The initial value of the select field.","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"((string | string[]) & (string | number | readonly string[]))"}},"onChange":{"defaultValue":null,"description":"The callback invoked when the value of the select field changes.\n@param value The value of the select field.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"(((value: string | string[]) => void) & FormEventHandler)"}},"placeholder":{"defaultValue":null,"description":"The placeholder text when there's no value.\nThe input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"isDisabled":{"defaultValue":{"value":"false"},"description":"If `true`, the select will be disabled.\nIf `true`, the form control will be disabled. This has 2 side effects:\n- The `FormLabel` will have `data-disabled` attribute\n- The form element (e.g, Input) will be disabled","name":"isDisabled","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},{"fileName":"saas-ui/node_modules/@chakra-ui/form-control/dist/form-control.d.ts","name":"FormControlOptions"}],"required":false,"type":{"name":"boolean"}},"options":{"defaultValue":null,"description":"An array of options\nIf you leave this empty the children prop will be rendered.","name":"options","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"FieldOptions"}},"multiple":{"defaultValue":null,"description":"Enable multiple select.","name":"multiple","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"boolean"}},"renderValue":{"defaultValue":null,"description":"The function used to render the value of the select field.\n@param value The value of the select field.\n@returns The rendered value.","name":"renderValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"SelectOptions"}],"required":false,"type":{"name":"((value: string | string[]) => ReactNode)"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SelectOption.json b/tooling/props-docs/dist/components/SelectOption.json new file mode 100644 index 000000000..42963ebdf --- /dev/null +++ b/tooling/props-docs/dist/components/SelectOption.json @@ -0,0 +1 @@ +{"tags":{"see":"https://saas-ui.dev/docs/components/forms/select"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"An option in a select list","displayName":"SelectOption","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Sidebar.json b/tooling/props-docs/dist/components/Sidebar.json new file mode 100644 index 000000000..6fc07ed04 --- /dev/null +++ b/tooling/props-docs/dist/components/Sidebar.json @@ -0,0 +1,190 @@ +{ + "SidebarOptions": { + "isOpen": { + "type": "boolean", + "required": false, + "description": "Control the visibility of the sidebar." + }, + "motionPreset": { + "type": "\"none\" | \"slideInOut\"", + "required": false, + "description": "The transition used when opening and closing the sidebar." + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback invoked when the sidebar is closed." + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback invoked when the sidebar is opened." + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "Spacing between child elements." + }, + "toggleBreakpoint": { + "type": "false | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\"", + "defaultValue": "lg", + "required": false, + "description": "Define the for the mobile nav. Use `false` to disable the mobile nav." + } + }, + "SidebarOverlay": {}, + "Sidebar": { + "isOpen": { + "type": "boolean", + "required": false, + "description": "Control the visibility of the sidebar." + }, + "motionPreset": { + "type": "\"none\" | \"slideInOut\"", + "required": false, + "description": "The transition used when opening and closing the sidebar." + }, + "onAnimationStart": { + "type": "(definition: AnimationDefinition) => void", + "required": false, + "description": "Callback when animation defined in `animate` begins.\n\nThe provided callback will be called with the triggering animation definition.\nIf this is a variant, it'll be the variant name, and if a target object\nthen it'll be the target object.\n\nThis way, it's possible to figure out which animation has started.\n\n```jsx\nfunction onStart() {\n console.log(\"Animation started\")\n}\n\n\n```" + }, + "onClose": { + "type": "() => void", + "required": false, + "description": "Callback invoked when the sidebar is closed." + }, + "onDrag": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when the component is dragged.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragEnd": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging ends.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onDragStart": { + "type": "(\n event: MouseEvent | TouchEvent | PointerEvent,\n info: PanInfo\n) => void", + "required": false, + "description": "Callback function that fires when dragging starts.\n\n```jsx\n console.log(info.point.x, info.point.y)\n }\n/>\n```" + }, + "onOpen": { + "type": "() => void", + "required": false, + "description": "Callback invoked when the sidebar is opened." + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "Spacing between child elements." + }, + "toggleBreakpoint": { + "type": "false | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\"", + "defaultValue": "lg", + "required": false, + "description": "Define the for the mobile nav. Use `false` to disable the mobile nav." + } + }, + "SidebarSection": { + "direction": { "type": "ResponsiveValue", "required": false } + }, + "SidebarToggleButton": { + "icon": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "isRound": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be perfectly round. Else, it'll be slightly round" + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + } + }, + "Nav": { + "orientation": { + "type": "\"vertical\" | \"horizontal\"", + "required": false + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false + } + }, + "NavGroup": { + "defaultIsOpen": { "type": "boolean", "required": false }, + "icon": { + "type": "ReactElement>", + "required": false + }, + "isCollapsible": { "type": "boolean", "required": false }, + "onClose": { "type": "() => void", "required": false }, + "onOpen": { "type": "() => void", "required": false }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + } + }, + "NavGroupTitle": { + "collapseIcon": { + "type": "string | number | boolean | ReactElement> | Iterable | ReactPortal | PromiseLikeOfReactNode | ((props: { ...; }) => ReactNode)", + "required": false + }, + "isCollapsible": { "type": "boolean", "required": false }, + "leftIcon": { + "type": "ReactElement>", + "required": false + } + }, + "NavItemLabel": {}, + "NavItem": { + "href": { + "type": "string", + "required": false, + "description": "The href attribute of the nav item,\nwill be wrapped in a `Link`, if `linkComponent` is configured in SaasProvider." + }, + "icon": { + "type": "ReactElement>", + "required": false, + "description": "Icon to be displayed in the nav item" + }, + "inset": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n>", + "required": false, + "description": "Inset of the item, used for nested items" + }, + "isActive": { + "type": "boolean", + "required": false, + "description": "If `true`, the nav item will be active" + }, + "tooltipProps": { + "type": "Omit", + "required": false, + "description": "Props to be passed to the tooltip" + } + } +} diff --git a/tooling/props-docs/dist/components/SidebarSection.json b/tooling/props-docs/dist/components/SidebarSection.json new file mode 100644 index 000000000..6e1a58070 --- /dev/null +++ b/tooling/props-docs/dist/components/SidebarSection.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/layout/sidebar"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Sidebar section that can contain sidebar items.","displayName":"SidebarSection","methods":[],"props":{"direction":{"defaultValue":null,"description":"","name":"direction","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SidebarSectionProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SidebarSectionProps"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SidebarToggleButton.json b/tooling/props-docs/dist/components/SidebarToggleButton.json new file mode 100644 index 000000000..00642ab49 --- /dev/null +++ b/tooling/props-docs/dist/components/SidebarToggleButton.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/layout/sidebar"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Button that toggles the sidebar visibility.","displayName":"SidebarToggleButton","methods":[],"props":{"icon":{"defaultValue":null,"description":"","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SidebarToggleButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"SidebarToggleButtonProps"}],"required":false,"type":{"name":"MaybeRenderProp<{ isOpen: boolean; }>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SignupView.json b/tooling/props-docs/dist/components/SignupView.json new file mode 100644 index 000000000..0fb8e69d6 --- /dev/null +++ b/tooling/props-docs/dist/components/SignupView.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"SignupView","methods":[],"props":{"action":{"defaultValue":null,"description":"The submit action, `logIn` or `signUp`","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthActionEnum"}},"type":{"defaultValue":{"value":"magiclink"},"description":"The authentication type, `magiclink` or `password`","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"AuthTypeEnum"}},"title":{"defaultValue":{"value":"Log in"},"description":"The form title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"submitLabel":{"defaultValue":{"value":"Log in"},"description":"Label for the submit button","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"Children are passed down to the underlying form\nThe child component","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"Render custom elements under the submit button","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"ReactNode"}},"onSuccess":{"defaultValue":null,"description":"Callback executed after succesful login or signup","name":"onSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((data: any) => void)"}},"onError":{"defaultValue":null,"description":"Error handler if login or signup fails","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((error: Error) => void)"}},"onValidationError":{"defaultValue":null,"description":"Callback executed when there are validation errors","name":"onValidationError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((errors: FieldErrors) => void)"}},"providers":{"defaultValue":null,"description":"List of OAuth providers","name":"providers","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"AvailableProviders"}},"oauthRedirectUrl":{"defaultValue":null,"description":"The redirect URL after successful OAuth login","name":"oauthRedirectUrl","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}},"providerLabel":{"defaultValue":{"value":"Continue with"},"description":"Label for the provider buttons","name":"providerLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}},"dividerLabel":{"defaultValue":{"value":"or continue with"},"description":"Label for the divider between oath and the form","name":"dividerLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthFormOptions"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Snackbar.json b/tooling/props-docs/dist/components/Snackbar.json new file mode 100644 index 000000000..5fb6e3c23 --- /dev/null +++ b/tooling/props-docs/dist/components/Snackbar.json @@ -0,0 +1,87 @@ +{ + "SnackbarOptions": { + "toString": { + "type": "(() => string) | (() => string)", + "required": true, + "description": "Returns a string representation of a string.\n\n\nReturns a string representation of an object." + }, + "valueOf": { + "type": "(() => string) | (() => Object)", + "required": true, + "description": "Returns the primitive value of the specified object." + } + }, + "SnackbarPromiseOptions": { + "error": { + "type": "SnackbarOptions | ((error: any) => SnackbarOptions)", + "required": true + }, + "success": { "type": "SnackbarOptions", "required": true }, + "loading": { "type": "SnackbarOptions", "required": false } + }, + "UseSnackbarOptions": { + "action": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false + }, + "containerStyle": { + "type": "StyleProps", + "required": false, + "description": "Optional style overrides for the container wrapping the toast component." + }, + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The description of the toast" + }, + "duration": { + "type": "number", + "defaultValue": "5000 ( = 5000ms )", + "required": false, + "description": "The delay before the toast hides (in milliseconds)\nIf set to `null`, toast will never dismiss." + }, + "icon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "A custom icon that will be displayed by the toast." + }, + "id": { + "type": "ToastId", + "required": false, + "description": "The `id` of the toast.\n\nMostly used when you need to prevent duplicate.\nBy default, we generate a unique `id` for each toast" + }, + "isClosable": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, toast will show a close button" + }, + "onCloseComplete": { + "type": "() => void", + "required": false, + "description": "Callback function to run side effects after the toast has closed." + }, + "position": { + "type": "ToastPosition", + "defaultValue": "bottom", + "required": false, + "description": "The placement of the toast" + }, + "render": { + "type": "(props: RenderProps) => ReactNode", + "required": false, + "description": "Render a component toast component.\nAny component passed will receive 2 props: `id` and `onClose`." + }, + "status": { + "type": "\"info\" | \"warning\" | \"success\" | \"error\" | \"loading\"", + "required": false, + "description": "The status of the toast." + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The title of the toast" + }, + "variant": { "type": "string", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/Sparklines.json b/tooling/props-docs/dist/components/Sparklines.json new file mode 100644 index 000000000..b4c48ede0 --- /dev/null +++ b/tooling/props-docs/dist/components/Sparklines.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-charts/src/index.ts","description":"","displayName":"Sparklines","methods":[],"props":{"data":{"defaultValue":null,"description":"","name":"data","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":true,"type":{"name":"number[]"}},"limit":{"defaultValue":null,"description":"","name":"limit","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":false,"type":{"name":"number"}},"fillColor":{"defaultValue":null,"description":"","name":"fillColor","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":false,"type":{"name":"string"}},"strokeWidth":{"defaultValue":null,"description":"","name":"strokeWidth","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":false,"type":{"name":"number"}},"gradientOpacity":{"defaultValue":null,"description":"","name":"gradientOpacity","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":false,"type":{"name":"number"}},"variant":{"defaultValue":null,"description":"","name":"variant","parent":{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-charts/src/sparklines.tsx","name":"SparklineProps"}],"required":false,"type":{"name":"\"line\" | \"solid\" | \"gradient\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Src.json b/tooling/props-docs/dist/components/Src.json new file mode 100644 index 000000000..646b59e93 --- /dev/null +++ b/tooling/props-docs/dist/components/Src.json @@ -0,0 +1,9 @@ +{ + "NProgress": { + "isAnimating": { + "type": "boolean", + "required": true, + "description": "Set to true to start the progress animation." + } + } +} diff --git a/tooling/props-docs/dist/components/StepForm.json b/tooling/props-docs/dist/components/StepForm.json new file mode 100644 index 000000000..6f63e1fa5 --- /dev/null +++ b/tooling/props-docs/dist/components/StepForm.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/step-form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"The wrapper component provides context, state, and focus management.","displayName":"StepForm","methods":[],"props":{"step":{"defaultValue":null,"description":"","name":"step","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"string | number"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"boolean"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"{ [x: string]: any; } | AsyncDefaultValues"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldValues"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/form.tsx","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/step-form.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Stepper.json b/tooling/props-docs/dist/components/Stepper.json new file mode 100644 index 000000000..fc9d43cd6 --- /dev/null +++ b/tooling/props-docs/dist/components/Stepper.json @@ -0,0 +1,88 @@ +{ + "StepperContent": { + "isOpen": { + "type": "boolean", + "required": false, + "description": "Show or hide the content, only when orientation is vertical." + }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false, + "description": "The orientation of the stepper." + } + }, + "StepsItem": { + "description": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The step description" + }, + "icon": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Show an icon instead of the step number" + }, + "isActive": { + "type": "boolean", + "required": false, + "description": "Show the step as active" + }, + "isCompleted": { + "type": "boolean", + "required": false, + "description": "Show the step as completed" + }, + "name": { + "type": "string", + "required": false, + "description": "The step name" + }, + "render": { + "type": "(\n props?: any\n) => ReactElement>", + "required": false, + "description": "Custom render function" + }, + "title": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The step title" + } + }, + "Steps": { + "index": { + "type": "number", + "required": false, + "description": "The current step index." + }, + "onChange": { + "type": "(index: number) => void", + "required": false, + "description": "Callback invoked when the step changes." + }, + "orientation": { + "type": "\"horizontal\" | \"vertical\"", + "required": false, + "description": "The orientation of the stepper." + }, + "step": { + "type": "string | number", + "required": false, + "description": "The current step index or name." + }, + "stepperProps": { + "type": "StepperProps", + "required": false, + "description": "Props to pass to the stepper component." + } + }, + "UseStep": { + "isActive": { "type": "boolean", "required": false }, + "isCompleted": { "type": "boolean", "required": false }, + "name": { "type": "string", "required": false } + }, + "UseStepper": { + "isCompleted": { "type": "boolean", "required": false }, + "onChange": { "type": "(index: number) => void", "required": false }, + "step": { "type": "string | number", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/StepperContainer.json b/tooling/props-docs/dist/components/StepperContainer.json new file mode 100644 index 000000000..e661d8cbe --- /dev/null +++ b/tooling/props-docs/dist/components/StepperContainer.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"StepperContainer","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/stepper.tsx","name":"StepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/stepper.tsx","name":"StepperProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"step":{"defaultValue":null,"description":"","name":"step","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"}],"required":false,"type":{"name":"string | number"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"}],"required":false,"type":{"name":"boolean"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/stepper/use-stepper.tsx","name":"UseStepperProps"}],"required":false,"type":{"name":"((index: number) => void)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StepperContent.json b/tooling/props-docs/dist/components/StepperContent.json new file mode 100644 index 000000000..da32ee416 --- /dev/null +++ b/tooling/props-docs/dist/components/StepperContent.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Renders the step content, is collapsible.","displayName":"StepperContent","methods":[],"props":{"isOpen":{"defaultValue":null,"description":"Show or hide the content","name":"isOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperContentProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperContentProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StepperIcon.json b/tooling/props-docs/dist/components/StepperIcon.json new file mode 100644 index 000000000..13f18d8a1 --- /dev/null +++ b/tooling/props-docs/dist/components/StepperIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Displays the current step or a completed icon.","displayName":"StepperIcon","methods":[],"props":{"icon":{"defaultValue":null,"description":"","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"}],"required":true,"type":{"name":"ReactNode"}},"isActive":{"defaultValue":null,"description":"","name":"isActive","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"}],"required":false,"type":{"name":"boolean"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperIconProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StepperSeparator.json b/tooling/props-docs/dist/components/StepperSeparator.json new file mode 100644 index 000000000..5bbd11658 --- /dev/null +++ b/tooling/props-docs/dist/components/StepperSeparator.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The separator between steps.","displayName":"StepperSeparator","methods":[],"props":{"isActive":{"defaultValue":null,"description":"","name":"isActive","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperSeparatorProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperSeparatorProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StepperStep.json b/tooling/props-docs/dist/components/StepperStep.json new file mode 100644 index 000000000..422f8d93f --- /dev/null +++ b/tooling/props-docs/dist/components/StepperStep.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Displays the icon and step title.","displayName":"StepperStep","methods":[],"props":{"title":{"defaultValue":null,"description":"The step title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"}],"required":true,"type":{"name":"ReactNode"}},"name":{"defaultValue":null,"description":"The step name, used for controlled steppers","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"}],"required":false,"type":{"name":"string"}},"icon":{"defaultValue":null,"description":"Show an icon instead of the step number","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"}],"required":false,"type":{"name":"ReactNode"}},"isActive":{"defaultValue":null,"description":"","name":"isActive","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"}],"required":false,"type":{"name":"boolean"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StepperSteps.json b/tooling/props-docs/dist/components/StepperSteps.json new file mode 100644 index 000000000..68ff55a91 --- /dev/null +++ b/tooling/props-docs/dist/components/StepperSteps.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Wrapper element containing the steps.","displayName":"StepperSteps","methods":[],"props":{"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"stepComponent":{"defaultValue":null,"description":"","name":"stepComponent","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StepperStepsProps"}],"required":false,"type":{"name":"JSXElementConstructor"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StructuredList.json b/tooling/props-docs/dist/components/StructuredList.json new file mode 100644 index 000000000..6d0bd8ceb --- /dev/null +++ b/tooling/props-docs/dist/components/StructuredList.json @@ -0,0 +1,49 @@ +{ + "StructuredList": { + "items": { + "type": "StructuredListItemProps[]", + "required": false, + "description": "An array of list items" + } + }, + "StructuredListHeader": { + "action": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "Action rendered next to the title" + }, + "level": { + "type": "number", + "required": false, + "description": "The aria-level" + } + }, + "StructuredListItem": { + "href": { "type": "string | object", "required": false }, + "onClick": { + "type": "(e: MouseEvent) => void", + "required": false + } + }, + "StructuredListButton": { + "as": { "type": "As", "required": false }, + "onClick": { + "type": "(e: MouseEvent) => void", + "required": false + } + }, + "StructuredListIcon": { + "size": { + "type": "ResponsiveValue", + "defaultValue": "5", + "required": false, + "description": "The icon size" + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The icon spacing, ltr supported" + } + }, + "StructuredListCell": {} +} diff --git a/tooling/props-docs/dist/components/StructuredListHeader.json b/tooling/props-docs/dist/components/StructuredListHeader.json new file mode 100644 index 000000000..85f08a5cd --- /dev/null +++ b/tooling/props-docs/dist/components/StructuredListHeader.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"StructuredListHeader","methods":[],"props":{"action":{"defaultValue":null,"description":"Action rendered next to the title","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListHeaderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListHeaderProps"}],"required":false,"type":{"name":"ReactNode"}},"level":{"defaultValue":null,"description":"The aria-level","name":"level","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListHeaderProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListHeaderProps"}],"required":false,"type":{"name":"number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/StructuredListIcon.json b/tooling/props-docs/dist/components/StructuredListIcon.json new file mode 100644 index 000000000..4a214bb29 --- /dev/null +++ b/tooling/props-docs/dist/components/StructuredListIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"StructuredListIcon","methods":[],"props":{"size":{"defaultValue":{"value":"5"},"description":"The icon size","name":"size","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListIconProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"spacing":{"defaultValue":null,"description":"The icon spacing, ltr supported","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListIconProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"StructuredListIconProps"}],"required":false,"type":{"name":"ResponsiveValue"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SubmitButton.json b/tooling/props-docs/dist/components/SubmitButton.json new file mode 100644 index 000000000..7be1c9741 --- /dev/null +++ b/tooling/props-docs/dist/components/SubmitButton.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/form"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"A button with type submit and default color scheme primary and isLoading state when the form is submitting.","displayName":"SubmitButton","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"disableIfUntouched":{"defaultValue":{"value":false},"description":"Disable the submit button if the form is untouched.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfUntouched`","name":"disableIfUntouched","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/submit-button.tsx","name":"SubmitButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/submit-button.tsx","name":"SubmitButtonProps"}],"required":false,"type":{"name":"boolean"}},"disableIfInvalid":{"defaultValue":{"value":false},"description":"Disable the submit button if the form is invalid.\n\nChange the default behavior by updating\n`SubmitButton.defaultProps.disableIfInvalid`","name":"disableIfInvalid","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/submit-button.tsx","name":"SubmitButtonProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/submit-button.tsx","name":"SubmitButtonProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/SwitchField.json b/tooling/props-docs/dist/components/SwitchField.json new file mode 100644 index 000000000..cc9e8b7de --- /dev/null +++ b/tooling/props-docs/dist/components/SwitchField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"SwitchField","methods":[],"props":{"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/TextareaField.json b/tooling/props-docs/dist/components/TextareaField.json new file mode 100644 index 000000000..47d2d232d --- /dev/null +++ b/tooling/props-docs/dist/components/TextareaField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"TextareaField","methods":[],"props":{"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Timeline.json b/tooling/props-docs/dist/components/Timeline.json new file mode 100644 index 000000000..5520f5710 --- /dev/null +++ b/tooling/props-docs/dist/components/Timeline.json @@ -0,0 +1,9 @@ +{ + "TimelineContent": {}, + "TimelineDot": {}, + "TimelineIcon": {}, + "TimelineItem": {}, + "Timeline": {}, + "TimelineSeparator": {}, + "TimelineTrack": {} +} diff --git a/tooling/props-docs/dist/components/TimelineItem.json b/tooling/props-docs/dist/components/TimelineItem.json new file mode 100644 index 000000000..b83a9abd7 --- /dev/null +++ b/tooling/props-docs/dist/components/TimelineItem.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"TimelineItem","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Toggle.json b/tooling/props-docs/dist/components/Toggle.json new file mode 100644 index 000000000..f5adade7a --- /dev/null +++ b/tooling/props-docs/dist/components/Toggle.json @@ -0,0 +1,118 @@ +{ + "ToggleButtonGroup": { + "defaultValue": { + "type": "TType extends \"checkbox\" ? TValue[] : TValue", + "required": false + }, + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "name": { "type": "string", "required": false }, + "onChange": { + "type": "(\n value: TType extends \"checkbox\" ? TValue[] : TValue\n) => void", + "required": false + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + }, + "type": { "type": "TType", "required": false }, + "value": { + "type": "TType extends \"checkbox\" ? TValue[] : TValue", + "required": false + } + }, + "ToggleButton": { + "autoFocus": { + "type": "boolean", + "required": false, + "description": "Whether the element should receive focus on render." + }, + "children": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The content to display in the button." + }, + "defaultSelected": { + "type": "boolean", + "required": false, + "description": "Whether the element should be selected (uncontrolled)." + }, + "isDisabled": { + "type": "boolean", + "required": false, + "description": "Whether the button is disabled." + }, + "isSelected": { + "type": "boolean", + "required": false, + "description": "Whether the element should be selected (controlled)." + }, + "onBlur": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element loses focus." + }, + "onChange": { + "type": "(isSelected: boolean) => void", + "required": false, + "description": "Handler that is called when the element's selection state changes." + }, + "onFocus": { + "type": "(e: FocusEvent) => void", + "required": false, + "description": "Handler that is called when the element receives focus." + }, + "onFocusChange": { + "type": "(isFocused: boolean) => void", + "required": false, + "description": "Handler that is called when the element's focus status changes." + }, + "onKeyDown": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is pressed." + }, + "onKeyUp": { + "type": "(e: KeyboardEvent) => void", + "required": false, + "description": "Handler that is called when a key is released." + }, + "onPress": { + "type": "(e: PressEvent) => void", + "required": false, + "description": "Handler that is called when the press is released over the target." + }, + "onPressChange": { + "type": "(isPressed: boolean) => void", + "required": false, + "description": "Handler that is called when the press state changes." + }, + "onPressEnd": { + "type": "(e: PressEvent) => void", + "required": false, + "description": "Handler that is called when a press interaction ends, either\nover the target or when the pointer leaves the target." + }, + "onPressStart": { + "type": "(e: PressEvent) => void", + "required": false, + "description": "Handler that is called when a press interaction starts." + }, + "onPressUp": { + "type": "(e: PressEvent) => void", + "required": false, + "description": "Handler that is called when a press is released over the target, regardless of\nwhether it started on the target or not." + } + } +} diff --git a/tooling/props-docs/dist/components/Toolbar.json b/tooling/props-docs/dist/components/Toolbar.json new file mode 100644 index 000000000..774e3924f --- /dev/null +++ b/tooling/props-docs/dist/components/Toolbar.json @@ -0,0 +1,153 @@ +{ + "ToolbarButton": { + "label": { "type": "string", "required": true }, + "icon": { + "type": "ReactElement>", + "required": false + }, + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"start\" | \"end\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + }, + "tooltipProps": { + "type": "Omit", + "required": false + } + }, + "Toolbar": {}, + "ToolbarToggleButton": { + "label": { "type": "string", "required": true }, + "icon": { + "type": "ReactElement>", + "required": false + }, + "iconSpacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "required": false, + "description": "The space between the button icon and label." + }, + "isActive": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be styled in its active state." + }, + "isChecked": { "type": "boolean", "required": false }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will be disabled." + }, + "isLoading": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the button will show a spinner." + }, + "leftIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon before the button's label." + }, + "loadingText": { + "type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement>\n | Iterable\n | ReactPortal\n | PromiseLikeOfReactNode", + "required": false, + "description": "The label to show in the button when `isLoading` is true\nIf no text is passed, it only shows the spinner" + }, + "rightIcon": { + "type": "ReactElement>", + "required": false, + "description": "If added, the button will show an icon after the button's label." + }, + "spinner": { + "type": "ReactElement>", + "required": false, + "description": "Replace the spinner component when `isLoading` is set to `true`" + }, + "spinnerPlacement": { + "type": "\"start\" | \"end\"", + "defaultValue": "start", + "required": false, + "description": "It determines the placement of the spinner when isLoading is true" + }, + "tooltipProps": { + "type": "Omit", + "required": false + }, + "type": { "type": "\"radio\" | \"checkbox\"", "required": false }, + "value": { "type": "string", "required": false } + }, + "ToolbarToggleGroup": { + "defaultValue": { "type": "string | string[]", "required": false }, + "isAttached": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, the borderRadius of button that are direct children will be altered\nto look flushed together" + }, + "isDisabled": { + "type": "boolean", + "defaultValue": false, + "required": false, + "description": "If `true`, all wrapped button will be disabled" + }, + "onChange": { + "type": "(value: string | string[]) => void", + "required": false + }, + "spacing": { + "type": "ResponsiveValue<\n | number\n | (string & {})\n | \"-moz-initial\"\n | \"inherit\"\n | \"initial\"\n | \"revert\"\n | \"revert-layer\"\n | \"unset\"\n | \"auto\"\n>", + "defaultValue": "'0.5rem'", + "required": false, + "description": "The spacing between the buttons" + }, + "type": { "type": "\"radio\" | \"checkbox\"", "required": false }, + "value": { "type": "string | string[]", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/UpdatePasswordForm.json b/tooling/props-docs/dist/components/UpdatePasswordForm.json new file mode 100644 index 000000000..8a07333f1 --- /dev/null +++ b/tooling/props-docs/dist/components/UpdatePasswordForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"UpdatePasswordForm","methods":[],"props":{"passwordLabel":{"defaultValue":{"value":"New password"},"description":"","name":"passwordLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"confirmLabel":{"defaultValue":{"value":"Confirm password"},"description":"","name":"confirmLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"helpText":{"defaultValue":null,"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"submitLabel":{"defaultValue":{"value":"Update password"},"description":"","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/UpdatePasswordView.json b/tooling/props-docs/dist/components/UpdatePasswordView.json new file mode 100644 index 000000000..d861e1d75 --- /dev/null +++ b/tooling/props-docs/dist/components/UpdatePasswordView.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"UpdatePasswordView","methods":[],"props":{"renderSuccess":{"defaultValue":null,"description":"","name":"renderSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/update-password-view.tsx","name":"UpdatePasswordViewProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/update-password-view.tsx","name":"UpdatePasswordViewProps"}],"required":false,"type":{"name":"((data: any) => ReactElement>)"}},"action":{"defaultValue":null,"description":"The submit action, `logIn` or `signUp`","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthActionEnum"}},"type":{"defaultValue":null,"description":"The authentication type, `magiclink` or `password`","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"AuthTypeEnum"}},"title":{"defaultValue":{"value":"Choose a new password"},"description":"The form title","name":"title","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"submitLabel":{"defaultValue":{"value":"\"Sign in\""},"description":"Label for the submit button","name":"submitLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"string"}},"children":{"defaultValue":null,"description":"Children are passed down to the underlying form","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"footer":{"defaultValue":null,"description":"Render custom elements under the submit button","name":"footer","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"ReactNode"}},"onSuccess":{"defaultValue":null,"description":"Callback executed after succesful login or signup","name":"onSuccess","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((data: any) => void)"}},"onError":{"defaultValue":null,"description":"Error handler if login or signup fails","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((error: Error) => void)"}},"onValidationError":{"defaultValue":null,"description":"Callback executed when there are validation errors","name":"onValidationError","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/auth-form.tsx","name":"AuthViewOptions"}],"required":false,"type":{"name":"((errors: FieldErrors) => void)"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}},"helpText":{"defaultValue":null,"description":"","name":"helpText","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"passwordLabel":{"defaultValue":null,"description":"","name":"passwordLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}},"confirmLabel":{"defaultValue":null,"description":"","name":"confirmLabel","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/components/forms/update-password-form.tsx","name":"UpdatePasswordFormProps"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Utils.json b/tooling/props-docs/dist/components/Utils.json new file mode 100644 index 000000000..22699b099 --- /dev/null +++ b/tooling/props-docs/dist/components/Utils.json @@ -0,0 +1,24 @@ +{ + "ExtendedFocusOptions": { + "isActive": { + "type": "(element: FocusableElement) => boolean", + "required": false, + "description": "Function that determines if the element is the active element" + }, + "nextTick": { + "type": "boolean", + "required": false, + "description": "If true, the element will be focused in the next tick" + }, + "preventScroll": { "type": "boolean", "required": false }, + "selectTextIfInput": { + "type": "boolean", + "required": false, + "description": "If true and element is an input element, the input's text will be selected" + } + }, + "PanSessionOptions": { + "threshold": { "type": "number", "required": false }, + "window": { "type": "Window", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/ViewIcon.json b/tooling/props-docs/dist/components/ViewIcon.json new file mode 100644 index 000000000..4db2f878e --- /dev/null +++ b/tooling/props-docs/dist/components/ViewIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ViewIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/ViewOffIcon.json b/tooling/props-docs/dist/components/ViewOffIcon.json new file mode 100644 index 000000000..e1717cf7e --- /dev/null +++ b/tooling/props-docs/dist/components/ViewOffIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"ViewOffIcon","methods":[],"props":{"htmlTranslate":{"defaultValue":null,"description":"","name":"htmlTranslate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"yes\" | \"no\""}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/WatchField.json b/tooling/props-docs/dist/components/WatchField.json new file mode 100644 index 000000000..ffd29ee7a --- /dev/null +++ b/tooling/props-docs/dist/components/WatchField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"WatchField","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"}],"required":true,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"}],"required":false,"type":{"name":"Value"}},"isDisabled":{"defaultValue":null,"description":"","name":"isDisabled","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"}],"required":false,"type":{"name":"boolean"}},"isExact":{"defaultValue":null,"description":"","name":"isExact","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/watch-field.tsx","name":"WatchFieldProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/Web3Address.json b/tooling/props-docs/dist/components/Web3Address.json new file mode 100644 index 000000000..41b749824 --- /dev/null +++ b/tooling/props-docs/dist/components/Web3Address.json @@ -0,0 +1,7 @@ +{ + "Web3Address": { + "address": { "type": "string", "required": true }, + "endLength": { "type": "number", "required": false }, + "startLength": { "type": "number", "required": false } + } +} diff --git a/tooling/props-docs/dist/components/createBox.json b/tooling/props-docs/dist/components/createBox.json new file mode 100644 index 000000000..0fe6eded6 --- /dev/null +++ b/tooling/props-docs/dist/components/createBox.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react-utils/src/index.ts","description":"","displayName":"createBox","methods":[],"props":{"borderBox":{"defaultValue":null,"description":"","name":"borderBox","declarations":[{"fileName":"saas-ui/node_modules/css-box-model/src/index.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"AnyRectType"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/createForm.json b/tooling/props-docs/dist/components/createForm.json new file mode 100644 index 000000000..7f2eabb00 --- /dev/null +++ b/tooling/props-docs/dist/components/createForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"createForm","methods":[],"props":{"resolver":{"defaultValue":null,"description":"","name":"resolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"}],"required":false,"type":{"name":"GetResolver"}},"fieldResolver":{"defaultValue":null,"description":"","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"}],"required":false,"type":{"name":"GetFieldResolver"}},"fields":{"defaultValue":null,"description":"","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"CreateFormProps"}],"required":false,"type":{"name":"Record>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/createFormDialog.json b/tooling/props-docs/dist/components/createFormDialog.json new file mode 100644 index 000000000..015f1429b --- /dev/null +++ b/tooling/props-docs/dist/components/createFormDialog.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-modals/src/index.ts","description":"","displayName":"createFormDialog","methods":[],"props":{"displayName":{"defaultValue":null,"description":"","name":"displayName","declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/form.tsx","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/createIcon.json b/tooling/props-docs/dist/components/createIcon.json new file mode 100644 index 000000000..e449b3b8d --- /dev/null +++ b/tooling/props-docs/dist/components/createIcon.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"createIcon","methods":[],"props":{"viewBox":{"defaultValue":{"value":"\"0 0 24 24\""},"description":"The icon `svg` viewBox","name":"viewBox","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"}],"required":false,"type":{"name":"string"}},"path":{"defaultValue":null,"description":"The `svg` path or group element","name":"path","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"}],"required":false,"type":{"name":"React.ReactElement | React.ReactElement[]"}},"d":{"defaultValue":null,"description":"If the `svg` has a single path, simply copy the path's `d` attribute","name":"d","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"}],"required":false,"type":{"name":"string"}},"displayName":{"defaultValue":null,"description":"The display name useful in the dev tools","name":"displayName","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"}],"required":false,"type":{"name":"string"}},"defaultProps":{"defaultValue":null,"description":"Default props automatically passed to the component; overwriteable","name":"defaultProps","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/icons/create-icon.tsx","name":"CreateIconOptions"}],"required":false,"type":{"name":"IconProps"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/createModals.json b/tooling/props-docs/dist/components/createModals.json new file mode 100644 index 000000000..3a0285d2f --- /dev/null +++ b/tooling/props-docs/dist/components/createModals.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-modals/src/index.ts","description":"","displayName":"createModals","methods":[],"props":{"modals":{"defaultValue":null,"description":"","name":"modals","parent":{"fileName":"saas-ui/packages/saas-ui-modals/src/create-modals.tsx","name":"CreateModalsOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-modals/src/create-modals.tsx","name":"CreateModalsOptions"}],"required":true,"type":{"name":"Record>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/endOfMonth.json b/tooling/props-docs/dist/components/endOfMonth.json new file mode 100644 index 000000000..f1f03f9ee --- /dev/null +++ b/tooling/props-docs/dist/components/endOfMonth.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Returns the last date of the month for the given date.","displayName":"endOfMonth","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"() => ZonedDateTime"}},"add":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"subtract":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"set":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"(fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime"}},"cycle":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"(field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"() => Date"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"() => string"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"(b: CalendarDate | CalendarDateTime | ZonedDateTime) => number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/endOfYear.json b/tooling/props-docs/dist/components/endOfYear.json new file mode 100644 index 000000000..d214ec112 --- /dev/null +++ b/tooling/props-docs/dist/components/endOfYear.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Returns the last day of the year for the given date.","displayName":"endOfYear","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"() => ZonedDateTime"}},"add":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"subtract":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"set":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"(fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime"}},"cycle":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"(field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"() => Date"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"() => string"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"(b: CalendarDate | CalendarDateTime | ZonedDateTime) => number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/startOfMonth.json b/tooling/props-docs/dist/components/startOfMonth.json new file mode 100644 index 000000000..1ef08bf42 --- /dev/null +++ b/tooling/props-docs/dist/components/startOfMonth.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Returns the first date of the month for the given date.","displayName":"startOfMonth","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"() => ZonedDateTime"}},"add":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"subtract":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"set":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"(fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime"}},"cycle":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"(field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"() => Date"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"() => string"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"(b: CalendarDate | CalendarDateTime | ZonedDateTime) => number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/startOfYear.json b/tooling/props-docs/dist/components/startOfYear.json new file mode 100644 index 000000000..d854f256c --- /dev/null +++ b/tooling/props-docs/dist/components/startOfYear.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Returns the first day of the year for the given date.","displayName":"startOfYear","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"() => ZonedDateTime"}},"add":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"subtract":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"set":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"(fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime"}},"cycle":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"(field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"() => Date"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"() => string"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"(b: CalendarDate | CalendarDateTime | ZonedDateTime) => number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/toLocalTimeZone.json b/tooling/props-docs/dist/components/toLocalTimeZone.json new file mode 100644 index 000000000..df7bfb87b --- /dev/null +++ b/tooling/props-docs/dist/components/toLocalTimeZone.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Converts the given `ZonedDateTime` into the user's local time zone.","displayName":"toLocalTimeZone","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"() => ZonedDateTime"}},"add":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"subtract":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"(duration: DateTimeDuration) => ZonedDateTime"}},"set":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"(fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime"}},"cycle":{"defaultValue":null,"description":"Returns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"(field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"() => Date"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"() => string"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"(b: CalendarDate | CalendarDateTime | ZonedDateTime) => number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/toTime.json b/tooling/props-docs/dist/components/toTime.json new file mode 100644 index 000000000..11a34a132 --- /dev/null +++ b/tooling/props-docs/dist/components/toTime.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-date-picker/src/index.ts","description":"Extracts the time components from a value containing a date and time.","displayName":"toTime","methods":[],"props":{"#private":{"defaultValue":null,"description":"","name":"#private","declarations":[],"required":true,"type":{"name":"any"}},"calendar":{"defaultValue":null,"description":"The calendar system associated with this date, e.g. Gregorian.","name":"calendar","declarations":[],"required":true,"type":{"name":"Calendar"}},"era":{"defaultValue":null,"description":"The calendar era for this date, e.g. \"BC\" or \"AD\".","name":"era","declarations":[],"required":true,"type":{"name":"string"}},"year":{"defaultValue":null,"description":"The year of this date within the era.","name":"year","declarations":[],"required":true,"type":{"name":"number"}},"month":{"defaultValue":null,"description":"The month number within the year. Note that some calendar systems such as Hebrew\nmay have a variable number of months per year. Therefore, month numbers may not\nalways correspond to the same month names in different years.","name":"month","declarations":[],"required":true,"type":{"name":"number"}},"day":{"defaultValue":null,"description":"The day number within the month.","name":"day","declarations":[],"required":true,"type":{"name":"number"}},"hour":{"defaultValue":null,"description":"The hour in the day, numbered from 0 to 23.","name":"hour","declarations":[],"required":true,"type":{"name":"number"}},"minute":{"defaultValue":null,"description":"The minute in the hour.","name":"minute","declarations":[],"required":true,"type":{"name":"number"}},"second":{"defaultValue":null,"description":"The second in the minute.","name":"second","declarations":[],"required":true,"type":{"name":"number"}},"millisecond":{"defaultValue":null,"description":"The millisecond in the second.","name":"millisecond","declarations":[],"required":true,"type":{"name":"number"}},"copy":{"defaultValue":null,"description":"Returns a copy of this date.","name":"copy","declarations":[],"required":true,"type":{"name":"(() => ZonedDateTime) | (() => CalendarDateTime)"}},"add":{"defaultValue":null,"description":"Returns a new `CalendarDateTime` with the given duration added to it.\nReturns a new `ZonedDateTime` with the given duration added to it.","name":"add","declarations":[],"required":true,"type":{"name":"((duration: DateTimeDuration) => ZonedDateTime) | ((duration: DateTimeDuration) => CalendarDateTime)"}},"subtract":{"defaultValue":null,"description":"Returns a new `CalendarDateTime` with the given duration subtracted from it.\nReturns a new `ZonedDateTime` with the given duration subtracted from it.","name":"subtract","declarations":[],"required":true,"type":{"name":"((duration: DateTimeDuration) => ZonedDateTime) | ((duration: DateTimeDuration) => CalendarDateTime)"}},"set":{"defaultValue":null,"description":"Returns a new `CalendarDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.\nReturns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.","name":"set","declarations":[],"required":true,"type":{"name":"((fields: DateFields & TimeFields, disambiguation?: Disambiguation | undefined) => ZonedDateTime) | ((fields: DateFields & TimeFields) => CalendarDateTime)"}},"cycle":{"defaultValue":null,"description":"Returns a new `CalendarDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.\nReturns a new `ZonedDateTime` with the given field adjusted by a specified amount.\nWhen the resulting value reaches the limits of the field, it wraps around.","name":"cycle","declarations":[],"required":true,"type":{"name":"((field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => ZonedDateTime) | ((field: keyof DateFields | keyof TimeFields, amount: number, options?: CycleTimeOptions | undefined) => CalendarDateTime)"}},"toDate":{"defaultValue":null,"description":"Converts the date to a native JavaScript Date object in the given time zone.\nConverts the date to a native JavaScript Date object.","name":"toDate","declarations":[],"required":true,"type":{"name":"(() => Date) | ((timeZone: string, disambiguation?: Disambiguation | undefined) => Date)"}},"toString":{"defaultValue":{},"description":"Converts the date to an ISO 8601 formatted string.\nConverts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.","name":"toString","declarations":[],"required":false,"type":{"name":"(() => string) | (() => string)"}},"compare":{"defaultValue":null,"description":"Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.","name":"compare","declarations":[],"required":true,"type":{"name":"((b: CalendarDate | CalendarDateTime | ZonedDateTime) => number) | ((b: CalendarDate | CalendarDateTime | ZonedDateTime) => number)"}},"timeZone":{"defaultValue":null,"description":"The IANA time zone identifier that this date and time is represented in.","name":"timeZone","declarations":[],"required":true,"type":{"name":"string"}},"offset":{"defaultValue":null,"description":"The UTC offset for this time, in seconds.","name":"offset","declarations":[],"required":true,"type":{"name":"number"}},"toAbsoluteString":{"defaultValue":null,"description":"Converts the date to an ISO 8601 formatted string in UTC.","name":"toAbsoluteString","declarations":[],"required":true,"type":{"name":"() => string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useArrayField.json b/tooling/props-docs/dist/components/useArrayField.json new file mode 100644 index 000000000..f3584b3b5 --- /dev/null +++ b/tooling/props-docs/dist/components/useArrayField.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"useArrayField","methods":[],"props":{"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"}],"required":true,"type":{"name":"string"}},"defaultValue":{"defaultValue":{"value":"{}"},"description":"Default value for new values in the array","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"Record"}},"keyName":{"defaultValue":{"value":"\"id\""},"description":"Default key name for rows, change this if your data uses a different 'id' field","name":"keyName","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"string"}},"min":{"defaultValue":null,"description":"","name":"min","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"max":{"defaultValue":null,"description":"","name":"max","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useArrayFieldRow.json b/tooling/props-docs/dist/components/useArrayFieldRow.json new file mode 100644 index 000000000..44034b149 --- /dev/null +++ b/tooling/props-docs/dist/components/useArrayFieldRow.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-forms/src/index.ts","description":"","displayName":"useArrayFieldRow","methods":[],"props":{"index":{"defaultValue":null,"description":"","name":"index","parent":{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"UseArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/src/use-array-field.tsx","name":"UseArrayFieldRowProps"}],"required":true,"type":{"name":"number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useCollapse.json b/tooling/props-docs/dist/components/useCollapse.json new file mode 100644 index 000000000..e31d3b6f5 --- /dev/null +++ b/tooling/props-docs/dist/components/useCollapse.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"useCollapse","methods":[],"props":{"defaultIsOpen":{"defaultValue":null,"description":"","name":"defaultIsOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"}],"required":false,"type":{"name":"boolean"}},"isOpen":{"defaultValue":null,"description":"","name":"isOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"}],"required":false,"type":{"name":"boolean"}},"onOpen":{"defaultValue":null,"description":"","name":"onOpen","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"}],"required":false,"type":{"name":"(() => void)"}},"onClose":{"defaultValue":null,"description":"","name":"onClose","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"}],"required":false,"type":{"name":"(() => void)"}},"isCollapsible":{"defaultValue":null,"description":"","name":"isCollapsible","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/collapse/use-collapse.ts","name":"UseCollapse"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useCommandBar.json b/tooling/props-docs/dist/components/useCommandBar.json new file mode 100644 index 000000000..8ef26e3c9 --- /dev/null +++ b/tooling/props-docs/dist/components/useCommandBar.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-command-bar/src/index.ts","description":"","displayName":"useCommandBar","methods":[],"props":{"shouldFilter":{"defaultValue":null,"description":"","name":"shouldFilter","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"boolean"}},"onFilter":{"defaultValue":null,"description":"","name":"onFilter","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"((string: string, search: string) => number)"}},"value":{"defaultValue":null,"description":"","name":"value","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"string"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"((search: string) => void)"}},"onSelect":{"defaultValue":null,"description":"","name":"onSelect","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"((value: string) => void)"}},"isOpen":{"defaultValue":null,"description":"","name":"isOpen","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"boolean"}},"onClose":{"defaultValue":null,"description":"","name":"onClose","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"(() => void)"}},"closeOnSelect":{"defaultValue":null,"description":"","name":"closeOnSelect","parent":{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-command-bar/src/command-bar-context.ts","name":"CommandBarOptions"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useContextMenu.json b/tooling/props-docs/dist/components/useContextMenu.json new file mode 100644 index 000000000..2f36a0d00 --- /dev/null +++ b/tooling/props-docs/dist/components/useContextMenu.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-core/src/index.ts","description":"","displayName":"useContextMenu","methods":[],"props":{"onClose":{"defaultValue":null,"description":"","name":"onClose","parent":{"fileName":"saas-ui/packages/saas-ui-core/src/menu/context-menu.tsx","name":"UseContextMenuProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/src/menu/context-menu.tsx","name":"UseContextMenuProps"}],"required":false,"type":{"name":"(() => void)"}},"initialFocusRef":{"defaultValue":null,"description":"The `ref` of the element that should receive focus when the popover opens.","name":"initialFocusRef","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"RefObject<{ focus(): void; }>"}},"closeOnSelect":{"defaultValue":{"value":"true"},"description":"If `true`, the menu will close when a menu item is\nclicked","name":"closeOnSelect","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"boolean"}},"closeOnBlur":{"defaultValue":{"value":"true"},"description":"If `true`, the menu will close when you click outside\nthe menu list","name":"closeOnBlur","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"boolean"}},"autoSelect":{"defaultValue":{"value":"true"},"description":"If `true`, the first enabled menu item will receive focus and be selected\nwhen the menu opens.","name":"autoSelect","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"boolean"}},"isLazy":{"defaultValue":{"value":"false"},"description":"Performance 🚀:\nIf `true`, the MenuItem rendering will be deferred\nuntil the menu is open.","name":"isLazy","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"boolean"}},"lazyBehavior":{"defaultValue":{"value":"\"unmount\""},"description":"Performance 🚀:\nThe lazy behavior of menu's content when not visible.\nOnly works when `isLazy={true}`\n\n- \"unmount\": The menu's content is always unmounted when not open.\n- \"keepMounted\": The menu's content initially unmounted,\nbut stays mounted when menu is open.","name":"lazyBehavior","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"LazyMode"}},"direction":{"defaultValue":null,"description":"If `rtl`, proper placement positions will be flipped i.e. 'top-right' will\nbecome 'top-left' and vice-verse","name":"direction","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"\"ltr\" | \"rtl\""}},"computePositionOnMount":{"defaultValue":null,"description":"","name":"computePositionOnMount","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/menu/dist/use-menu.d.ts","name":"UseMenuProps"}],"required":false,"type":{"name":"boolean"}},"offset":{"defaultValue":null,"description":"The main and cross-axis offset to displace popper element\nfrom its reference element.","name":"offset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"[number, number]"}},"gutter":{"defaultValue":{"value":"8"},"description":"The distance or margin between the reference and popper.\nIt is used internally to create an `offset` modifier.\n\nNB: If you define `offset` prop, it'll override the gutter.","name":"gutter","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"number"}},"preventOverflow":{"defaultValue":{"value":"true"},"description":"If `true`, will prevent the popper from being cut off and ensure\nit's visible within the boundary area.","name":"preventOverflow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"boolean"}},"flip":{"defaultValue":{"value":"true"},"description":"If `true`, the popper will change its placement and flip when it's\nabout to overflow its boundary area.","name":"flip","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"boolean"}},"matchWidth":{"defaultValue":{"value":"false"},"description":"If `true`, the popper will match the width of the reference at all times.\nIt's useful for `autocomplete`, `date-picker` and `select` patterns.","name":"matchWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"boolean"}},"boundary":{"defaultValue":{"value":"\"clippingParents\""},"description":"The boundary area for the popper. Used within the `preventOverflow` modifier","name":"boundary","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"HTMLElement | \"clippingParents\" | \"scrollParent\""}},"eventListeners":{"defaultValue":{"value":"true"},"description":"If provided, determines whether the popper will reposition itself on `scroll`\nand `resize` of the window.","name":"eventListeners","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"boolean | { scroll?: boolean; resize?: boolean; } | undefined"}},"arrowPadding":{"defaultValue":{"value":"8"},"description":"The padding required to prevent the arrow from\nreaching the very edge of the popper.","name":"arrowPadding","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"number"}},"strategy":{"defaultValue":{"value":"\"absolute\""},"description":"The CSS positioning strategy to use.","name":"strategy","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"\"fixed\" | \"absolute\""}},"placement":{"defaultValue":{"value":"\"bottom\""},"description":"The placement of the popper relative to its reference.","name":"placement","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"PlacementWithLogical"}},"modifiers":{"defaultValue":null,"description":"Array of popper.js modifiers. Check the docs to see\nthe list of possible modifiers you can pass.\n@see Docs https://popper.js.org/docs/v2/modifiers/","name":"modifiers","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/popper/dist/use-popper.d.ts","name":"UsePopperProps"}],"required":false,"type":{"name":"Partial>[]"}},"isOpen":{"defaultValue":null,"description":"","name":"isOpen","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"}],"required":false,"type":{"name":"boolean"}},"defaultIsOpen":{"defaultValue":null,"description":"","name":"defaultIsOpen","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"}],"required":false,"type":{"name":"boolean"}},"onOpen":{"defaultValue":null,"description":"","name":"onOpen","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"}],"required":false,"type":{"name":"(() => void)"}},"id":{"defaultValue":null,"description":"","name":"id","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/react-use-disclosure/dist/index.d.ts","name":"UseDisclosureProps"}],"required":false,"type":{"name":"string"}},"variant":{"defaultValue":null,"description":"","name":"variant","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"ResponsiveValue<\"dialog\" | (string & {})>"}},"size":{"defaultValue":null,"description":"","name":"size","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"colorScheme":{"defaultValue":null,"description":"","name":"colorScheme","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"(string & {}) | \"blue\" | \"cyan\" | \"gray\" | \"green\" | \"indigo\" | \"orange\" | \"pink\" | \"purple\" | \"red\" | \"teal\" | \"yellow\" | \"whiteAlpha\" | \"blackAlpha\" | \"linkedin\" | \"facebook\" | ... 6 more ..."}},"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"styleConfig":{"defaultValue":null,"description":"","name":"styleConfig","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"Record"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useController.json b/tooling/props-docs/dist/components/useController.json new file mode 100644 index 000000000..86bec0348 --- /dev/null +++ b/tooling/props-docs/dist/components/useController.json @@ -0,0 +1 @@ +{"tags":{"remarks":"[API](https://react-hook-form.com/api/usecontroller) • [Demo](https://codesandbox.io/s/usecontroller-0o8px)","param":"props - the path name to the form field value, and validation rules.","returns":"field properties, field and form state. {@link UseControllerReturn }","example":"```tsx\nfunction Input(props) {\n const { field, fieldState, formState } = useController(props);\n return (\n
\n \n

{fieldState.isTouched && \"Touched\"}

\n

{formState.isSubmitted ? \"submitted\" : \"\"}

\n
\n );\n}\n```"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Custom hook to work with controlled component, this function provide you with both form and field level state. Re-render is isolated at the hook level.","displayName":"useController","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/controller.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"string"}},"rules":{"defaultValue":null,"description":"","name":"rules","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/controller.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Omit, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/controller.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/controller.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"any"}},"control":{"defaultValue":null,"description":"","name":"control","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/controller.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Control"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useFieldArray.json b/tooling/props-docs/dist/components/useFieldArray.json new file mode 100644 index 000000000..0bc84a8d0 --- /dev/null +++ b/tooling/props-docs/dist/components/useFieldArray.json @@ -0,0 +1 @@ +{"tags":{"remarks":"[API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn)","param":"props - useFieldArray props","returns":"methods - functions to manipulate with the Field Arrays (dynamic inputs) {@link UseFieldArrayReturn }","example":"```tsx\nfunction App() {\n const { register, control, handleSubmit, reset, trigger, setError } = useForm({\n defaultValues: {\n test: []\n }\n });\n const { fields, append } = useFieldArray({\n control,\n name: \"test\"\n });\n\n return (\n
console.log(data))}>\n {fields.map((item, index) => (\n \n ))}\n \n \n
\n );\n}\n```"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"A custom hook that exposes convenient methods to perform operations with a list of dynamic inputs that need to be appended, updated, removed etc. • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn) • [Video](https://youtu.be/4MrbfGSFY2A)","displayName":"useFieldArray","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/fieldArray.d.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"string"}},"keyName":{"defaultValue":null,"description":"","name":"keyName","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/fieldArray.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"control":{"defaultValue":null,"description":"","name":"control","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/fieldArray.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Control"}},"rules":{"defaultValue":null,"description":"","name":"rules","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/fieldArray.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"({ validate?: Validate[], TFieldValues> | Record[], TFieldValues>>; } & Pick<...>)"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/fieldArray.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useForm.json b/tooling/props-docs/dist/components/useForm.json new file mode 100644 index 000000000..35c4ea6cb --- /dev/null +++ b/tooling/props-docs/dist/components/useForm.json @@ -0,0 +1 @@ +{"tags":{"remarks":"[API](https://react-hook-form.com/api/useform) • [Demo](https://codesandbox.io/s/react-hook-form-get-started-ts-5ksmm) • [Video](https://www.youtube.com/watch?v=RkXv4AXXC_4)","param":"props - form configuration and validation parameters.","returns":"methods - individual functions to manage the form state. {@link UseFormReturn }","example":"```tsx\nfunction App() {\n const { register, handleSubmit, watch, formState: { errors } } = useForm();\n const onSubmit = data => console.log(data);\n\n console.log(watch(\"example\"));\n\n return (\n
\n \n \n {errors.exampleRequired && This field is required}\n \n
\n );\n}\n```"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Custom hook to manage the entire form.","displayName":"useForm","methods":[],"props":{"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"AsyncDefaultValues | { [x: string]: any; }"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldValues"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"TContext"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useFormState.json b/tooling/props-docs/dist/components/useFormState.json new file mode 100644 index 000000000..912ad8b2a --- /dev/null +++ b/tooling/props-docs/dist/components/useFormState.json @@ -0,0 +1 @@ +{"tags":{"remarks":"[API](https://react-hook-form.com/api/useformstate) • [Demo](https://codesandbox.io/s/useformstate-75xly)","param":"props - include options on specify fields to subscribe. {@link UseFormStateReturn }","example":"```tsx\nfunction App() {\n const { register, handleSubmit, control } = useForm({\n defaultValues: {\n firstName: \"firstName\"\n }});\n const { dirtyFields } = useFormState({\n control\n });\n const onSubmit = (data) => console.log(data);\n\n return (\n
\n \n {dirtyFields.firstName &&

Field is dirty.

}\n \n
\n );\n}\n```"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"This custom hook allows you to subscribe to each form state, and isolate the re-render at the custom hook level. It has its scope in terms of form state subscription, so it would not affect other useFormState and useForm. Using this hook can reduce the re-render impact on large and complex form application.","displayName":"useFormState","methods":[],"props":{"control":{"defaultValue":null,"description":"","name":"control","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Control"}},"disabled":{"defaultValue":null,"description":"","name":"disabled","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"name":{"defaultValue":null,"description":"","name":"name","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string | Path[] | readonly Path[]"}},"exact":{"defaultValue":null,"description":"","name":"exact","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useFormStep.json b/tooling/props-docs/dist/components/useFormStep.json new file mode 100644 index 000000000..a3a91894a --- /dev/null +++ b/tooling/props-docs/dist/components/useFormStep.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"useFormStep","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"}],"required":true,"type":{"name":"string"}},"schema":{"defaultValue":null,"description":"","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"}],"required":false,"type":{"name":"any"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"}],"required":false,"type":{"name":"any"}},"onSubmit":{"defaultValue":null,"description":"","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"UseFormStepProps"}],"required":false,"type":{"name":"FormStepSubmitHandler"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useLogin.json b/tooling/props-docs/dist/components/useLogin.json new file mode 100644 index 000000000..50e86dad2 --- /dev/null +++ b/tooling/props-docs/dist/components/useLogin.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-auth/src/index.ts","description":"","displayName":"useLogin","methods":[],"props":{"action":{"defaultValue":{"value":"logIn"},"description":"","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"UseLoginProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-auth/src/provider.tsx","name":"UseLoginProps"}],"required":false,"type":{"name":"AuthActionEnum"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useSnackbar.json b/tooling/props-docs/dist/components/useSnackbar.json new file mode 100644 index 000000000..2fb198e02 --- /dev/null +++ b/tooling/props-docs/dist/components/useSnackbar.json @@ -0,0 +1 @@ +{"tags":{"see":"Docs https://saas-ui.dev/docs/components/feedback/snackbar"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The snackbar component is used to give feedback after certain actions.","displayName":"useSnackbar","methods":[],"props":{"icon":{"defaultValue":null,"description":"A custom icon that will be displayed by the toast.","name":"icon","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"}],"required":false,"type":{"name":"ReactNode"}},"action":{"defaultValue":null,"description":"","name":"action","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"}],"required":false,"type":{"name":"ReactNode"}},"variant":{"defaultValue":null,"description":"","name":"variant","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseSnackbarOptions"}],"required":false,"type":{"name":"string"}},"position":{"defaultValue":{"value":"\"bottom\""},"description":"The placement of the toast","name":"position","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"ToastPosition"}},"duration":{"defaultValue":{"value":"5000 ( = 5000ms )"},"description":"The delay before the toast hides (in milliseconds)\nIf set to `null`, toast will never dismiss.","name":"duration","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"number | null"}},"render":{"defaultValue":null,"description":"Render a component toast component.\nAny component passed will receive 2 props: `id` and `onClose`.","name":"render","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"((props: RenderProps) => ReactNode)"}},"title":{"defaultValue":null,"description":"The title of the toast","name":"title","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"ReactNode"}},"description":{"defaultValue":null,"description":"The description of the toast","name":"description","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"ReactNode"}},"isClosable":{"defaultValue":{"value":"false"},"description":"If `true`, toast will show a close button","name":"isClosable","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"boolean"}},"status":{"defaultValue":null,"description":"The status of the toast.","name":"status","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"\"loading\" | \"info\" | \"warning\" | \"success\" | \"error\""}},"id":{"defaultValue":null,"description":"The `id` of the toast.\n\nMostly used when you need to prevent duplicate.\nBy default, we generate a unique `id` for each toast","name":"id","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"ToastId"}},"onCloseComplete":{"defaultValue":null,"description":"Callback function to run side effects after the toast has closed.","name":"onCloseComplete","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"(() => void)"}},"containerStyle":{"defaultValue":null,"description":"Optional style overrides for the container wrapping the toast component.","name":"containerStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/toast/dist/toast.types-f226a101.d.ts","name":"UseToastOptions"}],"required":false,"type":{"name":"StyleProps"}},"size":{"defaultValue":null,"description":"","name":"size","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"colorScheme":{"defaultValue":null,"description":"","name":"colorScheme","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"(string & {}) | \"blue\" | \"cyan\" | \"gray\" | \"green\" | \"indigo\" | \"orange\" | \"pink\" | \"purple\" | \"red\" | \"teal\" | \"yellow\" | \"whiteAlpha\" | \"blackAlpha\" | \"linkedin\" | \"facebook\" | ... 6 more ..."}},"orientation":{"defaultValue":null,"description":"","name":"orientation","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"styleConfig":{"defaultValue":null,"description":"","name":"styleConfig","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ThemingProps"}],"required":false,"type":{"name":"Record"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useStep.json b/tooling/props-docs/dist/components/useStep.json new file mode 100644 index 000000000..a453b56f1 --- /dev/null +++ b/tooling/props-docs/dist/components/useStep.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"useStep","methods":[],"props":{"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"}],"required":false,"type":{"name":"string"}},"isActive":{"defaultValue":null,"description":"","name":"isActive","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"}],"required":false,"type":{"name":"boolean"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepProps"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useStepForm.json b/tooling/props-docs/dist/components/useStepForm.json new file mode 100644 index 000000000..54c1410d2 --- /dev/null +++ b/tooling/props-docs/dist/components/useStepForm.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"useStepForm","methods":[],"props":{"step":{"defaultValue":null,"description":"","name":"step","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"string | number"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"boolean"}},"transition":{"defaultValue":null,"description":"The CSS `transition` property","name":"transition","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"style":{"defaultValue":null,"description":"","name":"style","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"CSSProperties"}},"onAnimationStart":{"defaultValue":null,"description":"","name":"onAnimationStart","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onDragStart":{"defaultValue":null,"description":"","name":"onDragStart","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragEnd":{"defaultValue":null,"description":"","name":"onDragEnd","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDrag":{"defaultValue":null,"description":"","name":"onDrag","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"p":{"defaultValue":null,"description":"Padding on top, left, bottom and right","name":"p","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"slot":{"defaultValue":null,"description":"","name":"slot","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"title":{"defaultValue":null,"description":"","name":"title","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"defaultChecked":{"defaultValue":null,"description":"","name":"defaultChecked","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string | number | readonly string[]"}},"suppressContentEditableWarning":{"defaultValue":null,"description":"","name":"suppressContentEditableWarning","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"suppressHydrationWarning":{"defaultValue":null,"description":"","name":"suppressHydrationWarning","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"accessKey":{"defaultValue":null,"description":"","name":"accessKey","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"autoFocus":{"defaultValue":null,"description":"","name":"autoFocus","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"className":{"defaultValue":null,"description":"","name":"className","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"contentEditable":{"defaultValue":null,"description":"","name":"contentEditable","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"\"inherit\" | Booleanish"}},"contextMenu":{"defaultValue":null,"description":"","name":"contextMenu","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"dir":{"defaultValue":null,"description":"","name":"dir","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"draggable":{"defaultValue":null,"description":"","name":"draggable","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"Booleanish"}},"hidden":{"defaultValue":null,"description":"","name":"hidden","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"id":{"defaultValue":null,"description":"","name":"id","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"lang":{"defaultValue":null,"description":"","name":"lang","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"nonce":{"defaultValue":null,"description":"","name":"nonce","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"","name":"placeholder","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"spellCheck":{"defaultValue":null,"description":"","name":"spellCheck","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"Booleanish"}},"tabIndex":{"defaultValue":null,"description":"","name":"tabIndex","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"number"}},"translate":{"defaultValue":null,"description":"","name":"translate","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"\"yes\" | \"no\""}},"radioGroup":{"defaultValue":null,"description":"","name":"radioGroup","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"role":{"defaultValue":null,"description":"","name":"role","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"AriaRole"}},"about":{"defaultValue":null,"description":"","name":"about","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"content":{"defaultValue":null,"description":"","name":"content","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"datatype":{"defaultValue":null,"description":"","name":"datatype","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"inlist":{"defaultValue":null,"description":"","name":"inlist","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"any"}},"prefix":{"defaultValue":null,"description":"","name":"prefix","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"property":{"defaultValue":null,"description":"","name":"property","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"rel":{"defaultValue":null,"description":"","name":"rel","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"resource":{"defaultValue":null,"description":"","name":"resource","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"rev":{"defaultValue":null,"description":"","name":"rev","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"typeof":{"defaultValue":null,"description":"","name":"typeof","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"vocab":{"defaultValue":null,"description":"","name":"vocab","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"autoCapitalize":{"defaultValue":null,"description":"","name":"autoCapitalize","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"autoCorrect":{"defaultValue":null,"description":"","name":"autoCorrect","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"autoSave":{"defaultValue":null,"description":"","name":"autoSave","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"color":{"defaultValue":null,"description":"The CSS `color` property","name":"color","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"itemProp":{"defaultValue":null,"description":"","name":"itemProp","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"itemScope":{"defaultValue":null,"description":"","name":"itemScope","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"itemType":{"defaultValue":null,"description":"","name":"itemType","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"itemID":{"defaultValue":null,"description":"","name":"itemID","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"itemRef":{"defaultValue":null,"description":"","name":"itemRef","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"results":{"defaultValue":null,"description":"","name":"results","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"number"}},"security":{"defaultValue":null,"description":"","name":"security","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"unselectable":{"defaultValue":null,"description":"","name":"unselectable","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"\"on\" | \"off\""}},"inputMode":{"defaultValue":null,"description":"Hints at the type of data that might be entered by the user while editing the element or its contents\n@see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute","name":"inputMode","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"\"none\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\""}},"is":{"defaultValue":null,"description":"Specify that a standard HTML element should behave like a defined custom built-in element\n@see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is","name":"is","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"aria-activedescendant":{"defaultValue":null,"description":"Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","name":"aria-activedescendant","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-atomic":{"defaultValue":null,"description":"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.","name":"aria-atomic","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-autocomplete":{"defaultValue":null,"description":"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\npresented if they are made.","name":"aria-autocomplete","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"list\" | \"none\" | \"inline\" | \"both\""}},"aria-busy":{"defaultValue":null,"description":"Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.","name":"aria-busy","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-checked":{"defaultValue":null,"description":"Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets.\n@see aria-pressed\n@see aria-selected.","name":"aria-checked","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"boolean | \"true\" | \"false\" | \"mixed\""}},"aria-colcount":{"defaultValue":null,"description":"Defines the total number of columns in a table, grid, or treegrid.\n@see aria-colindex.","name":"aria-colcount","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-colindex":{"defaultValue":null,"description":"Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.\n@see aria-colcount\n@see aria-colspan.","name":"aria-colindex","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-colspan":{"defaultValue":null,"description":"Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.\n@see aria-colindex\n@see aria-rowspan.","name":"aria-colspan","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-controls":{"defaultValue":null,"description":"Identifies the element (or elements) whose contents or presence are controlled by the current element.\n@see aria-owns.","name":"aria-controls","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-current":{"defaultValue":null,"description":"Indicates the element that represents the current item within a container or set of related elements.","name":"aria-current","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"boolean | \"time\" | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\""}},"aria-describedby":{"defaultValue":null,"description":"Identifies the element (or elements) that describes the object.\n@see aria-labelledby","name":"aria-describedby","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-details":{"defaultValue":null,"description":"Identifies the element that provides a detailed, extended description for the object.\n@see aria-describedby.","name":"aria-details","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-disabled":{"defaultValue":null,"description":"Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.\n@see aria-hidden\n@see aria-readonly.","name":"aria-disabled","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-dropeffect":{"defaultValue":null,"description":"Indicates what functions can be performed when a dragged object is released on the drop target.\n@deprecated in ARIA 1.1","name":"aria-dropeffect","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"link\" | \"none\" | \"copy\" | \"move\" | \"execute\" | \"popup\""}},"aria-errormessage":{"defaultValue":null,"description":"Identifies the element that provides an error message for the object.\n@see aria-invalid\n@see aria-describedby.","name":"aria-errormessage","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-expanded":{"defaultValue":null,"description":"Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","name":"aria-expanded","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-flowto":{"defaultValue":null,"description":"Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\nallows assistive technology to override the general default of reading in document source order.","name":"aria-flowto","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-grabbed":{"defaultValue":null,"description":"Indicates an element's \"grabbed\" state in a drag-and-drop operation.\n@deprecated in ARIA 1.1","name":"aria-grabbed","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-haspopup":{"defaultValue":null,"description":"Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","name":"aria-haspopup","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"boolean | \"dialog\" | \"menu\" | \"true\" | \"false\" | \"grid\" | \"listbox\" | \"tree\""}},"aria-hidden":{"defaultValue":null,"description":"Indicates whether the element is exposed to an accessibility API.\n@see aria-disabled.","name":"aria-hidden","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-invalid":{"defaultValue":null,"description":"Indicates the entered value does not conform to the format expected by the application.\n@see aria-errormessage.","name":"aria-invalid","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\""}},"aria-keyshortcuts":{"defaultValue":null,"description":"Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","name":"aria-keyshortcuts","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-label":{"defaultValue":null,"description":"Defines a string value that labels the current element.\n@see aria-labelledby.","name":"aria-label","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-labelledby":{"defaultValue":null,"description":"Identifies the element (or elements) that labels the current element.\n@see aria-describedby.","name":"aria-labelledby","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-level":{"defaultValue":null,"description":"Defines the hierarchical level of an element within a structure.","name":"aria-level","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-live":{"defaultValue":null,"description":"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.","name":"aria-live","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"off\" | \"assertive\" | \"polite\""}},"aria-modal":{"defaultValue":null,"description":"Indicates whether an element is modal when displayed.","name":"aria-modal","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-multiline":{"defaultValue":null,"description":"Indicates whether a text box accepts multiple lines of input or only a single line.","name":"aria-multiline","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-multiselectable":{"defaultValue":null,"description":"Indicates that the user may select more than one item from the current selectable descendants.","name":"aria-multiselectable","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-orientation":{"defaultValue":null,"description":"Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","name":"aria-orientation","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"horizontal\" | \"vertical\""}},"aria-owns":{"defaultValue":null,"description":"Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship\nbetween DOM elements where the DOM hierarchy cannot be used to represent the relationship.\n@see aria-controls.","name":"aria-owns","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-placeholder":{"defaultValue":null,"description":"Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.\nA hint could be a sample value or a brief description of the expected format.","name":"aria-placeholder","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-posinset":{"defaultValue":null,"description":"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.\n@see aria-setsize.","name":"aria-posinset","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-pressed":{"defaultValue":null,"description":"Indicates the current \"pressed\" state of toggle buttons.\n@see aria-checked\n@see aria-selected.","name":"aria-pressed","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"boolean | \"true\" | \"false\" | \"mixed\""}},"aria-readonly":{"defaultValue":null,"description":"Indicates that the element is not editable, but is otherwise operable.\n@see aria-disabled.","name":"aria-readonly","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-relevant":{"defaultValue":null,"description":"Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\n@see aria-atomic.","name":"aria-relevant","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\""}},"aria-required":{"defaultValue":null,"description":"Indicates that user input is required on the element before a form may be submitted.","name":"aria-required","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-roledescription":{"defaultValue":null,"description":"Defines a human-readable, author-localized description for the role of an element.","name":"aria-roledescription","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"aria-rowcount":{"defaultValue":null,"description":"Defines the total number of rows in a table, grid, or treegrid.\n@see aria-rowindex.","name":"aria-rowcount","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-rowindex":{"defaultValue":null,"description":"Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.\n@see aria-rowcount\n@see aria-rowspan.","name":"aria-rowindex","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-rowspan":{"defaultValue":null,"description":"Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.\n@see aria-rowindex\n@see aria-colspan.","name":"aria-rowspan","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-selected":{"defaultValue":null,"description":"Indicates the current \"selected\" state of various widgets.\n@see aria-checked\n@see aria-pressed.","name":"aria-selected","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"Booleanish"}},"aria-setsize":{"defaultValue":null,"description":"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.\n@see aria-posinset.","name":"aria-setsize","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-sort":{"defaultValue":null,"description":"Indicates if items in a table or grid are sorted in ascending or descending order.","name":"aria-sort","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"\"none\" | \"ascending\" | \"descending\" | \"other\""}},"aria-valuemax":{"defaultValue":null,"description":"Defines the maximum allowed value for a range widget.","name":"aria-valuemax","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-valuemin":{"defaultValue":null,"description":"Defines the minimum allowed value for a range widget.","name":"aria-valuemin","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-valuenow":{"defaultValue":null,"description":"Defines the current value for a range widget.\n@see aria-valuetext.","name":"aria-valuenow","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"number"}},"aria-valuetext":{"defaultValue":null,"description":"Defines the human readable text alternative of aria-valuenow for a range widget.","name":"aria-valuetext","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"AriaAttributes"}],"required":false,"type":{"name":"string"}},"dangerouslySetInnerHTML":{"defaultValue":null,"description":"","name":"dangerouslySetInnerHTML","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"{ __html: string | TrustedHTML; }"}},"onCopy":{"defaultValue":null,"description":"","name":"onCopy","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onCopyCapture":{"defaultValue":null,"description":"","name":"onCopyCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onCut":{"defaultValue":null,"description":"","name":"onCut","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onCutCapture":{"defaultValue":null,"description":"","name":"onCutCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onPaste":{"defaultValue":null,"description":"","name":"onPaste","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onPasteCapture":{"defaultValue":null,"description":"","name":"onPasteCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ClipboardEventHandler"}},"onCompositionEnd":{"defaultValue":null,"description":"","name":"onCompositionEnd","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionEndCapture":{"defaultValue":null,"description":"","name":"onCompositionEndCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStart":{"defaultValue":null,"description":"","name":"onCompositionStart","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionStartCapture":{"defaultValue":null,"description":"","name":"onCompositionStartCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdate":{"defaultValue":null,"description":"","name":"onCompositionUpdate","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onCompositionUpdateCapture":{"defaultValue":null,"description":"","name":"onCompositionUpdateCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"CompositionEventHandler"}},"onFocus":{"defaultValue":null,"description":"","name":"onFocus","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FocusEventHandler"}},"onFocusCapture":{"defaultValue":null,"description":"","name":"onFocusCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FocusEventHandler"}},"onBlur":{"defaultValue":null,"description":"","name":"onBlur","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FocusEventHandler"}},"onBlurCapture":{"defaultValue":null,"description":"","name":"onBlurCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FocusEventHandler"}},"onChange":{"defaultValue":null,"description":"Triggers when any of the field change.","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"WatchObserver"}},"onChangeCapture":{"defaultValue":null,"description":"","name":"onChangeCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onBeforeInput":{"defaultValue":null,"description":"","name":"onBeforeInput","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onBeforeInputCapture":{"defaultValue":null,"description":"","name":"onBeforeInputCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onInput":{"defaultValue":null,"description":"","name":"onInput","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onInputCapture":{"defaultValue":null,"description":"","name":"onInputCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onReset":{"defaultValue":null,"description":"","name":"onReset","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onResetCapture":{"defaultValue":null,"description":"","name":"onResetCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onSubmit":{"defaultValue":null,"description":"The submit handler.","name":"onSubmit","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":true,"type":{"name":"SubmitHandler"}},"onSubmitCapture":{"defaultValue":null,"description":"","name":"onSubmitCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onInvalid":{"defaultValue":null,"description":"","name":"onInvalid","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onInvalidCapture":{"defaultValue":null,"description":"","name":"onInvalidCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"FormEventHandler"}},"onLoad":{"defaultValue":null,"description":"","name":"onLoad","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadCapture":{"defaultValue":null,"description":"","name":"onLoadCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onError":{"defaultValue":null,"description":"Triggers when there are validation errors.","name":"onError","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"SubmitErrorHandler"}},"onErrorCapture":{"defaultValue":null,"description":"","name":"onErrorCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onKeyDown":{"defaultValue":null,"description":"","name":"onKeyDown","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyDownCapture":{"defaultValue":null,"description":"","name":"onKeyDownCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPress":{"defaultValue":null,"description":"@deprecated","name":"onKeyPress","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyPressCapture":{"defaultValue":null,"description":"@deprecated","name":"onKeyPressCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUp":{"defaultValue":null,"description":"","name":"onKeyUp","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onKeyUpCapture":{"defaultValue":null,"description":"","name":"onKeyUpCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"KeyboardEventHandler"}},"onAbort":{"defaultValue":null,"description":"","name":"onAbort","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onAbortCapture":{"defaultValue":null,"description":"","name":"onAbortCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onCanPlay":{"defaultValue":null,"description":"","name":"onCanPlay","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayCapture":{"defaultValue":null,"description":"","name":"onCanPlayCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThrough":{"defaultValue":null,"description":"","name":"onCanPlayThrough","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onCanPlayThroughCapture":{"defaultValue":null,"description":"","name":"onCanPlayThroughCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onDurationChange":{"defaultValue":null,"description":"","name":"onDurationChange","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onDurationChangeCapture":{"defaultValue":null,"description":"","name":"onDurationChangeCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEmptied":{"defaultValue":null,"description":"","name":"onEmptied","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEmptiedCapture":{"defaultValue":null,"description":"","name":"onEmptiedCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEncrypted":{"defaultValue":null,"description":"","name":"onEncrypted","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEncryptedCapture":{"defaultValue":null,"description":"","name":"onEncryptedCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEnded":{"defaultValue":null,"description":"","name":"onEnded","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onEndedCapture":{"defaultValue":null,"description":"","name":"onEndedCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadedData":{"defaultValue":null,"description":"","name":"onLoadedData","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadedDataCapture":{"defaultValue":null,"description":"","name":"onLoadedDataCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadata":{"defaultValue":null,"description":"","name":"onLoadedMetadata","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadedMetadataCapture":{"defaultValue":null,"description":"","name":"onLoadedMetadataCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadStart":{"defaultValue":null,"description":"","name":"onLoadStart","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onLoadStartCapture":{"defaultValue":null,"description":"","name":"onLoadStartCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPause":{"defaultValue":null,"description":"","name":"onPause","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPauseCapture":{"defaultValue":null,"description":"","name":"onPauseCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPlay":{"defaultValue":null,"description":"","name":"onPlay","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPlayCapture":{"defaultValue":null,"description":"","name":"onPlayCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPlaying":{"defaultValue":null,"description":"","name":"onPlaying","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onPlayingCapture":{"defaultValue":null,"description":"","name":"onPlayingCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onProgress":{"defaultValue":null,"description":"","name":"onProgress","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onProgressCapture":{"defaultValue":null,"description":"","name":"onProgressCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onRateChange":{"defaultValue":null,"description":"","name":"onRateChange","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onRateChangeCapture":{"defaultValue":null,"description":"","name":"onRateChangeCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onResize":{"defaultValue":null,"description":"","name":"onResize","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onResizeCapture":{"defaultValue":null,"description":"","name":"onResizeCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSeeked":{"defaultValue":null,"description":"","name":"onSeeked","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSeekedCapture":{"defaultValue":null,"description":"","name":"onSeekedCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSeeking":{"defaultValue":null,"description":"","name":"onSeeking","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSeekingCapture":{"defaultValue":null,"description":"","name":"onSeekingCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onStalled":{"defaultValue":null,"description":"","name":"onStalled","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onStalledCapture":{"defaultValue":null,"description":"","name":"onStalledCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSuspend":{"defaultValue":null,"description":"","name":"onSuspend","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSuspendCapture":{"defaultValue":null,"description":"","name":"onSuspendCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdate":{"defaultValue":null,"description":"","name":"onTimeUpdate","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onTimeUpdateCapture":{"defaultValue":null,"description":"","name":"onTimeUpdateCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChange":{"defaultValue":null,"description":"","name":"onVolumeChange","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onVolumeChangeCapture":{"defaultValue":null,"description":"","name":"onVolumeChangeCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onWaiting":{"defaultValue":null,"description":"","name":"onWaiting","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onWaitingCapture":{"defaultValue":null,"description":"","name":"onWaitingCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onAuxClick":{"defaultValue":null,"description":"","name":"onAuxClick","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onAuxClickCapture":{"defaultValue":null,"description":"","name":"onAuxClickCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onClick":{"defaultValue":null,"description":"","name":"onClick","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onClickCapture":{"defaultValue":null,"description":"","name":"onClickCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onContextMenu":{"defaultValue":null,"description":"","name":"onContextMenu","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onContextMenuCapture":{"defaultValue":null,"description":"","name":"onContextMenuCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClick":{"defaultValue":null,"description":"","name":"onDoubleClick","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onDoubleClickCapture":{"defaultValue":null,"description":"","name":"onDoubleClickCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onDragCapture":{"defaultValue":null,"description":"","name":"onDragCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragEndCapture":{"defaultValue":null,"description":"","name":"onDragEndCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragEnter":{"defaultValue":null,"description":"","name":"onDragEnter","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragEnterCapture":{"defaultValue":null,"description":"","name":"onDragEnterCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragExit":{"defaultValue":null,"description":"","name":"onDragExit","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragExitCapture":{"defaultValue":null,"description":"","name":"onDragExitCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragLeave":{"defaultValue":null,"description":"","name":"onDragLeave","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragLeaveCapture":{"defaultValue":null,"description":"","name":"onDragLeaveCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragOver":{"defaultValue":null,"description":"","name":"onDragOver","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragOverCapture":{"defaultValue":null,"description":"","name":"onDragOverCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDragStartCapture":{"defaultValue":null,"description":"","name":"onDragStartCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDrop":{"defaultValue":null,"description":"","name":"onDrop","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onDropCapture":{"defaultValue":null,"description":"","name":"onDropCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"DragEventHandler"}},"onMouseDown":{"defaultValue":null,"description":"","name":"onMouseDown","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseDownCapture":{"defaultValue":null,"description":"","name":"onMouseDownCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseEnter":{"defaultValue":null,"description":"","name":"onMouseEnter","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseLeave":{"defaultValue":null,"description":"","name":"onMouseLeave","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseMove":{"defaultValue":null,"description":"","name":"onMouseMove","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseMoveCapture":{"defaultValue":null,"description":"","name":"onMouseMoveCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseOut":{"defaultValue":null,"description":"","name":"onMouseOut","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseOutCapture":{"defaultValue":null,"description":"","name":"onMouseOutCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseOver":{"defaultValue":null,"description":"","name":"onMouseOver","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseOverCapture":{"defaultValue":null,"description":"","name":"onMouseOverCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseUp":{"defaultValue":null,"description":"","name":"onMouseUp","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onMouseUpCapture":{"defaultValue":null,"description":"","name":"onMouseUpCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"MouseEventHandler"}},"onSelect":{"defaultValue":null,"description":"","name":"onSelect","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onSelectCapture":{"defaultValue":null,"description":"","name":"onSelectCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"ReactEventHandler"}},"onTouchCancel":{"defaultValue":null,"description":"","name":"onTouchCancel","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchCancelCapture":{"defaultValue":null,"description":"","name":"onTouchCancelCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchEnd":{"defaultValue":null,"description":"","name":"onTouchEnd","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchEndCapture":{"defaultValue":null,"description":"","name":"onTouchEndCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchMove":{"defaultValue":null,"description":"","name":"onTouchMove","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchMoveCapture":{"defaultValue":null,"description":"","name":"onTouchMoveCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchStart":{"defaultValue":null,"description":"","name":"onTouchStart","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onTouchStartCapture":{"defaultValue":null,"description":"","name":"onTouchStartCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TouchEventHandler"}},"onPointerDown":{"defaultValue":null,"description":"","name":"onPointerDown","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerDownCapture":{"defaultValue":null,"description":"","name":"onPointerDownCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerMove":{"defaultValue":null,"description":"","name":"onPointerMove","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerMoveCapture":{"defaultValue":null,"description":"","name":"onPointerMoveCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerUp":{"defaultValue":null,"description":"","name":"onPointerUp","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerUpCapture":{"defaultValue":null,"description":"","name":"onPointerUpCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancel":{"defaultValue":null,"description":"","name":"onPointerCancel","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerCancelCapture":{"defaultValue":null,"description":"","name":"onPointerCancelCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnter":{"defaultValue":null,"description":"","name":"onPointerEnter","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerEnterCapture":{"defaultValue":null,"description":"","name":"onPointerEnterCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeave":{"defaultValue":null,"description":"","name":"onPointerLeave","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerLeaveCapture":{"defaultValue":null,"description":"","name":"onPointerLeaveCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerOver":{"defaultValue":null,"description":"","name":"onPointerOver","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerOverCapture":{"defaultValue":null,"description":"","name":"onPointerOverCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerOut":{"defaultValue":null,"description":"","name":"onPointerOut","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onPointerOutCapture":{"defaultValue":null,"description":"","name":"onPointerOutCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCapture":{"defaultValue":null,"description":"","name":"onGotPointerCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onGotPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onGotPointerCaptureCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCapture":{"defaultValue":null,"description":"","name":"onLostPointerCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onLostPointerCaptureCapture":{"defaultValue":null,"description":"","name":"onLostPointerCaptureCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"PointerEventHandler"}},"onScroll":{"defaultValue":null,"description":"","name":"onScroll","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"UIEventHandler"}},"onScrollCapture":{"defaultValue":null,"description":"","name":"onScrollCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"UIEventHandler"}},"onWheel":{"defaultValue":null,"description":"","name":"onWheel","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"WheelEventHandler"}},"onWheelCapture":{"defaultValue":null,"description":"","name":"onWheelCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"WheelEventHandler"}},"onAnimationStartCapture":{"defaultValue":null,"description":"","name":"onAnimationStartCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEnd":{"defaultValue":null,"description":"","name":"onAnimationEnd","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationEndCapture":{"defaultValue":null,"description":"","name":"onAnimationEndCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIteration":{"defaultValue":null,"description":"","name":"onAnimationIteration","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onAnimationIterationCapture":{"defaultValue":null,"description":"","name":"onAnimationIterationCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"AnimationEventHandler"}},"onTransitionEnd":{"defaultValue":null,"description":"","name":"onTransitionEnd","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TransitionEventHandler"}},"onTransitionEndCapture":{"defaultValue":null,"description":"","name":"onTransitionEndCapture","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"DOMAttributes"}],"required":false,"type":{"name":"TransitionEventHandler"}},"key":{"defaultValue":null,"description":"","name":"key","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"Attributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"Attributes"}],"required":false,"type":{"name":"Key | null"}},"rotate":{"defaultValue":null,"description":"Sets the rotation value of the element","name":"rotate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scale":{"defaultValue":null,"description":"Sets the scale value of the element","name":"scale","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"alignContent":{"defaultValue":null,"description":"The CSS `align-content` property.\n\nIt defines the distribution of space between and around\ncontent items along a flexbox cross-axis or a grid's block axis.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/align-content)","name":"alignContent","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"alignItems":{"defaultValue":null,"description":"The CSS `align-items` property.\n\nIt defines the `align-self` value on all direct children as a group.\n\n- In Flexbox, it controls the alignment of items on the Cross Axis.\n- In Grid Layout, it controls the alignment of items on the Block Axis within their grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/align-items)","name":"alignItems","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"alignSelf":{"defaultValue":null,"description":"The CSS `align-self` property.\n\nIt works like `align-items`, but applies only to a\nsingle flexbox item, instead of all of them.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/align-self)","name":"alignSelf","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"appearance":{"defaultValue":null,"description":"The CSS `appearance` property","name":"appearance","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backdropFilter":{"defaultValue":null,"description":"The CSS `backdrop-filter` property. When set to `auto`, you allow\nChakra UI to define the color based on the backdrop filter style props\n(`backdropBlur`, `backdropSaturate`, etc.)","name":"backdropFilter","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue<\"auto\" | BackdropFilter>"}},"backgroundAttachment":{"defaultValue":null,"description":"The CSS `background-attachment` property","name":"backgroundAttachment","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backgroundBlendMode":{"defaultValue":null,"description":"The CSS `background-blend-mode` property","name":"backgroundBlendMode","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backgroundClip":{"defaultValue":null,"description":"The CSS `background-clip` property","name":"backgroundClip","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"text\" | BackgroundClip>"}},"backgroundColor":{"defaultValue":null,"description":"The CSS `background-color` property","name":"backgroundColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"backgroundImage":{"defaultValue":null,"description":"The CSS `background-image` property","name":"backgroundImage","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backgroundRepeat":{"defaultValue":null,"description":"The CSS `background-repeat` property","name":"backgroundRepeat","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backgroundSize":{"defaultValue":null,"description":"The CSS `background-size` property","name":"backgroundSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"blockSize":{"defaultValue":null,"description":"","name":"blockSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockEndColor":{"defaultValue":null,"description":"","name":"borderBlockEndColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderBlockEndColor>"}},"borderBlockEndStyle":{"defaultValue":null,"description":"","name":"borderBlockEndStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockEndWidth":{"defaultValue":null,"description":"","name":"borderBlockEndWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockStartColor":{"defaultValue":null,"description":"","name":"borderBlockStartColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderBlockStartColor>"}},"borderBlockStartStyle":{"defaultValue":null,"description":"","name":"borderBlockStartStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockStartWidth":{"defaultValue":null,"description":"","name":"borderBlockStartWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomColor":{"defaultValue":null,"description":"The CSS `border-bottom-color` property","name":"borderBottomColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderBottomColor>"}},"borderBottomLeftRadius":{"defaultValue":null,"description":"The CSS `border-bottom-left-radius` property","name":"borderBottomLeftRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomRightRadius":{"defaultValue":null,"description":"The CSS `border-bottom-right-radius` property","name":"borderBottomRightRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomStyle":{"defaultValue":null,"description":"The CSS `border-bottom-style` property","name":"borderBottomStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomWidth":{"defaultValue":null,"description":"The CSS `border-bottom-width` property","name":"borderBottomWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndEndRadius":{"defaultValue":null,"description":"","name":"borderEndEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndStartRadius":{"defaultValue":null,"description":"","name":"borderEndStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineEndColor":{"defaultValue":null,"description":"","name":"borderInlineEndColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderInlineEndColor>"}},"borderInlineEndStyle":{"defaultValue":null,"description":"","name":"borderInlineEndStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineEndWidth":{"defaultValue":null,"description":"","name":"borderInlineEndWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineStartColor":{"defaultValue":null,"description":"","name":"borderInlineStartColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderInlineStartColor>"}},"borderInlineStartStyle":{"defaultValue":null,"description":"","name":"borderInlineStartStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineStartWidth":{"defaultValue":null,"description":"","name":"borderInlineStartWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderLeftColor":{"defaultValue":null,"description":"The CSS `border-left-color` property","name":"borderLeftColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderLeftColor>"}},"borderLeftStyle":{"defaultValue":null,"description":"The CSS `border-left-style` property","name":"borderLeftStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderLeftWidth":{"defaultValue":null,"description":"The CSS `border-left-width` property","name":"borderLeftWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderRightColor":{"defaultValue":null,"description":"The CSS `border-right-color` property","name":"borderRightColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderRightColor>"}},"borderRightStyle":{"defaultValue":null,"description":"The CSS `border-right-styles` property","name":"borderRightStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderRightWidth":{"defaultValue":null,"description":"The CSS `border-right-width` property","name":"borderRightWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartEndRadius":{"defaultValue":null,"description":"","name":"borderStartEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartStartRadius":{"defaultValue":null,"description":"","name":"borderStartStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopColor":{"defaultValue":null,"description":"The CSS `border-top-color` property","name":"borderTopColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderTopColor>"}},"borderTopLeftRadius":{"defaultValue":null,"description":"The CSS `border-top-left-radius` property","name":"borderTopLeftRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopRightRadius":{"defaultValue":null,"description":"The CSS `border-top-right-radius` property","name":"borderTopRightRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopStyle":{"defaultValue":null,"description":"The CSS `border-top-style` property","name":"borderTopStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopWidth":{"defaultValue":null,"description":"The CSS `border-top-width` property","name":"borderTopWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bottom":{"defaultValue":null,"description":"The CSS `bottom` property","name":"bottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"boxDecorationBreak":{"defaultValue":null,"description":"The CSS `box-decoration` property","name":"boxDecorationBreak","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"boxShadow":{"defaultValue":null,"description":"The `box-shadow` property","name":"boxShadow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"boxSizing":{"defaultValue":null,"description":"The CSS `box-sizing` property","name":"boxSizing","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"BoxSizing"}},"clipPath":{"defaultValue":null,"description":"The CSS `clip-path` property.\n\nIt creates a clipping region that sets what part of an element should be shown.","name":"clipPath","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"columnGap":{"defaultValue":null,"description":"The CSS `column-gap` property.\n\nIt sets the size of the gap (gutter) between an element's columns.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/column-gap)","name":"columnGap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"cursor":{"defaultValue":null,"description":"The CSS `cursor` property","name":"cursor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"display":{"defaultValue":null,"description":"The CSS `display` property","name":"display","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"filter":{"defaultValue":null,"description":"The CSS `filter` property. When set to `auto`, you allow\nChakra UI to define the color based on the filter style props\n(`blur`, `saturate`, etc.)","name":"filter","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue<\"auto\" | Filter>"}},"flexBasis":{"defaultValue":null,"description":"The CSS `flex-basis` property.\n\nIt defines the initial main size of a flex item.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-basis)","name":"flexBasis","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"flexDirection":{"defaultValue":null,"description":"The CSS `flex-direction` property.\n\nIt defines how flex items are placed in the flex container\ndefining the main axis and the direction (normal or reversed).\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-direction)","name":"flexDirection","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"flexGrow":{"defaultValue":null,"description":"The CSS `flex-grow` property.\n\nIt defines how much a flexbox item should grow\nif there's space available.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-grow)","name":"flexGrow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"flexShrink":{"defaultValue":null,"description":"The CSS `flex-shrink` property.\n\nIt defines how much a flexbox item should shrink\nif there's not enough space available.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-shrink)","name":"flexShrink","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"flexWrap":{"defaultValue":null,"description":"The CSS `flex-wrap` property.\n\nIt defines whether flex items are forced onto one line or\ncan wrap onto multiple lines. If wrapping is allowed,\nit sets the direction that lines are stacked.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-wrap)","name":"flexWrap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"float":{"defaultValue":null,"description":"The CSS `float` property","name":"float","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"fontFamily":{"defaultValue":null,"description":"The CSS `font-family` property","name":"fontFamily","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue<\"body\" | \"heading\" | FontFamily | \"mono\">"}},"fontSize":{"defaultValue":null,"description":"The CSS `font-size` property","name":"fontSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"fontStyle":{"defaultValue":null,"description":"The CSS `font-style` property","name":"fontStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"fontWeight":{"defaultValue":null,"description":"The CSS `font-weight` property","name":"fontWeight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridAutoColumns":{"defaultValue":null,"description":"The CSS `grid-auto-columns` property.\n\nIt specifies the size of an implicitly-created grid column track or pattern of tracks.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns)","name":"gridAutoColumns","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"gridAutoFlow":{"defaultValue":null,"description":"The CSS `grid-auto-flow` property\n\nIt controls how the auto-placement algorithm works,\nspecifying exactly how auto-placed items get flowed into the grid.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow)","name":"gridAutoFlow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridAutoRows":{"defaultValue":null,"description":"The CSS `grid-auto-rows` property.\n\nIt specifies the size of an implicitly-created grid row track or pattern of tracks.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows)","name":"gridAutoRows","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"gridColumnEnd":{"defaultValue":null,"description":"The CSS `grid-column` property\n\nIt specifies a grid item’s end position within the grid column by\ncontributing a line, a span, or nothing (automatic) to its grid placement,\nthereby specifying the block-end edge of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end)","name":"gridColumnEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridColumnStart":{"defaultValue":null,"description":"The CSS `grid-column` property.\n\nIt specifies a grid item’s start position within the grid column by\ncontributing a line, a span, or nothing (automatic) to its grid placement\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start)","name":"gridColumnStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridRowEnd":{"defaultValue":null,"description":"The CSS `grid-row-end` property\n\nIt specifies a grid item’s end position within the grid row by\ncontributing a line, a span, or nothing (automatic) to its grid placement,\nthereby specifying the `inline-end` edge of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end)","name":"gridRowEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridRowStart":{"defaultValue":null,"description":"The CSS `grid-row-start` property\n\nIt specifies a grid item’s start position within the grid row by\ncontributing a line, a span, or nothing (automatic) to its grid placement,\nthereby specifying the `inline-start` edge of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start)","name":"gridRowStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridTemplateAreas":{"defaultValue":null,"description":"The CSS `grid-template-areas` property.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas)","name":"gridTemplateAreas","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridTemplateColumns":{"defaultValue":null,"description":"The CSS `grid-template-columns` property\n\nIt defines the line names and track sizing functions of the grid columns.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns)","name":"gridTemplateColumns","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"gridTemplateRows":{"defaultValue":null,"description":"The CSS `grid-template-rows` property.\n\nIt defines the line names and track sizing functions of the grid rows.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows)","name":"gridTemplateRows","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"height":{"defaultValue":null,"description":"The CSS `height` property","name":"height","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"inlineSize":{"defaultValue":null,"description":"","name":"inlineSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"inset":{"defaultValue":null,"description":"The CSS `left`, `right`, `top`, `bottom` property","name":"inset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetBlock":{"defaultValue":null,"description":"","name":"insetBlock","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"insetBlockEnd":{"defaultValue":null,"description":"","name":"insetBlockEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetBlockStart":{"defaultValue":null,"description":"","name":"insetBlockStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetInline":{"defaultValue":null,"description":"","name":"insetInline","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"insetInlineEnd":{"defaultValue":null,"description":"When the direction is `ltr`, `insetInlineEnd` is equivalent to `right`.\nWhen the direction is `rtl`, `insetInlineEnd` is equivalent to `left`.","name":"insetInlineEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetInlineStart":{"defaultValue":null,"description":"","name":"insetInlineStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"isolation":{"defaultValue":null,"description":"The CSS `isolation` property","name":"isolation","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"justifyContent":{"defaultValue":null,"description":"The CSS `justify-content` property.\n\nIt defines how the browser distributes space between and around content items\nalong the main-axis of a flex container, and the inline axis of a grid container.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/justify-content)","name":"justifyContent","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"justifyItems":{"defaultValue":null,"description":"The CSS `justify-items` property.\n\nIt defines the default `justify-self` for all items of the box,\ngiving them all a default way of justifying each box\nalong the appropriate axis.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/justify-items)","name":"justifyItems","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"justifySelf":{"defaultValue":null,"description":"The CSS `justify-self` property.\n\nIt defines the way a box is justified inside its\nalignment container along the appropriate axis.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-flow)","name":"justifySelf","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"left":{"defaultValue":null,"description":"The CSS `left` property","name":"left","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"letterSpacing":{"defaultValue":null,"description":"The CSS `letter-spacing` property","name":"letterSpacing","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"lineHeight":{"defaultValue":null,"description":"The CSS `line-height` property","name":"lineHeight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"listStyleImage":{"defaultValue":null,"description":"The CSS `list-style-image` property","name":"listStyleImage","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"listStylePosition":{"defaultValue":null,"description":"The CSS `list-style-position` property","name":"listStylePosition","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"listStyleType":{"defaultValue":null,"description":"","name":"listStyleType","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginBlock":{"defaultValue":null,"description":"","name":"marginBlock","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginBlockEnd":{"defaultValue":null,"description":"","name":"marginBlockEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginBlockStart":{"defaultValue":null,"description":"","name":"marginBlockStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginBottom":{"defaultValue":null,"description":"Margin on bottom","name":"marginBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginInline":{"defaultValue":null,"description":"","name":"marginInline","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginInlineEnd":{"defaultValue":null,"description":"When direction is `ltr`, `marginInlineEnd` is equivalent to `marginRight`.\nWhen direction is `rtl`, `marginInlineEnd` is equivalent to `marginLeft`.","name":"marginInlineEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginInlineStart":{"defaultValue":null,"description":"When direction is `ltr`, `marginInlineStart` is equivalent to `marginLeft`.\nWhen direction is `rtl`, `marginInlineStart` is equivalent to `marginRight`.","name":"marginInlineStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginLeft":{"defaultValue":null,"description":"Margin on left","name":"marginLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginRight":{"defaultValue":null,"description":"Margin on right","name":"marginRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginTop":{"defaultValue":null,"description":"Margin on top","name":"marginTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxBlockSize":{"defaultValue":null,"description":"","name":"maxBlockSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxHeight":{"defaultValue":null,"description":"The CSS `max-height` property","name":"maxHeight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxInlineSize":{"defaultValue":null,"description":"","name":"maxInlineSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxWidth":{"defaultValue":null,"description":"The CSS `max-width` property","name":"maxWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minBlockSize":{"defaultValue":null,"description":"","name":"minBlockSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minHeight":{"defaultValue":null,"description":"The CSS `min-height` property","name":"minHeight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minInlineSize":{"defaultValue":null,"description":"","name":"minInlineSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minWidth":{"defaultValue":null,"description":"The CSS `min-width` property","name":"minWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"mixBlendMode":{"defaultValue":null,"description":"The `mix-blend-mode` property","name":"mixBlendMode","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"objectFit":{"defaultValue":null,"description":"The CSS `object-fit` property","name":"objectFit","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"objectPosition":{"defaultValue":null,"description":"The CSS `object-position` property","name":"objectPosition","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"opacity":{"defaultValue":null,"description":"The CSS `opacity` property","name":"opacity","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"order":{"defaultValue":null,"description":"The CSS `order` property.\n\nIt defines the order to lay out an item in a flex or grid container.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/order)","name":"order","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"outlineColor":{"defaultValue":null,"description":"The CSS `outline-color` property","name":"outlineColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"outlineOffset":{"defaultValue":null,"description":"The CSS `outline-offset` property","name":"outlineOffset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"overflowWrap":{"defaultValue":null,"description":"The CSS `overflow-wrap` property","name":"overflowWrap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overflowX":{"defaultValue":null,"description":"The CSS `overflow-x` property","name":"overflowX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overflowY":{"defaultValue":null,"description":"The CSS `overflow-y` property","name":"overflowY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscrollBehaviorX":{"defaultValue":null,"description":"The CSS `overscroll-behavior-x` property","name":"overscrollBehaviorX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscrollBehaviorY":{"defaultValue":null,"description":"The CSS `overscroll-behavior-y` property","name":"overscrollBehaviorY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingBlock":{"defaultValue":null,"description":"","name":"paddingBlock","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingBlockEnd":{"defaultValue":null,"description":"","name":"paddingBlockEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingBlockStart":{"defaultValue":null,"description":"","name":"paddingBlockStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingBottom":{"defaultValue":null,"description":"Padding on bottom","name":"paddingBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingInline":{"defaultValue":null,"description":"","name":"paddingInline","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingInlineEnd":{"defaultValue":null,"description":"When direction is `ltr`, `paddingInlineEnd` is equivalent to `paddingRight`.\nWhen direction is `rtl`, `paddingInlineEnd` is equivalent to `paddingLeft`.","name":"paddingInlineEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingInlineStart":{"defaultValue":null,"description":"When direction is `ltr`, `paddingInlineStart` is equivalent to `paddingLeft`.\nWhen direction is `rtl`, `paddingInlineStart` is equivalent to `paddingRight`.","name":"paddingInlineStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingLeft":{"defaultValue":null,"description":"Padding on left","name":"paddingLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingRight":{"defaultValue":null,"description":"Padding on right","name":"paddingRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingTop":{"defaultValue":null,"description":"Padding on top","name":"paddingTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"placeContent":{"defaultValue":null,"description":"The CSS `place-content` property.\n\nIt allows you to align content along both the block and\ninline directions at once (i.e. the align-content and justify-content properties)\nin a relevant layout system such as Grid or Flexbox.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-content)","name":"placeContent","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pointerEvents":{"defaultValue":null,"description":"The CSS `pointer-events` property","name":"pointerEvents","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"position":{"defaultValue":null,"description":"The CSS `position` property","name":"position","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"resize":{"defaultValue":null,"description":"The CSS `resize` property","name":"resize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"right":{"defaultValue":null,"description":"The CSS `right` property","name":"right","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"rowGap":{"defaultValue":null,"description":"The CSS `row-gap` property.\n\nIt sets the size of the gap (gutter) between an element's grid rows.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/row-gap)","name":"rowGap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"scrollBehavior":{"defaultValue":null,"description":"","name":"scrollBehavior","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMargin":{"defaultValue":null,"description":"","name":"scrollMargin","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMarginBottom":{"defaultValue":null,"description":"","name":"scrollMarginBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMarginLeft":{"defaultValue":null,"description":"","name":"scrollMarginLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMarginRight":{"defaultValue":null,"description":"","name":"scrollMarginRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMarginTop":{"defaultValue":null,"description":"","name":"scrollMarginTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPadding":{"defaultValue":null,"description":"","name":"scrollPadding","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingBottom":{"defaultValue":null,"description":"","name":"scrollPaddingBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingLeft":{"defaultValue":null,"description":"","name":"scrollPaddingLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingRight":{"defaultValue":null,"description":"","name":"scrollPaddingRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingTop":{"defaultValue":null,"description":"","name":"scrollPaddingTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollSnapAlign":{"defaultValue":null,"description":"","name":"scrollSnapAlign","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollSnapStop":{"defaultValue":null,"description":"","name":"scrollSnapStop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollSnapType":{"defaultValue":null,"description":"","name":"scrollSnapType","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textAlign":{"defaultValue":null,"description":"The CSS `text-align` property","name":"textAlign","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textDecorationColor":{"defaultValue":null,"description":"The CSS `text-decoration-color` property","name":"textDecorationColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | TextDecorationColor>"}},"textDecorationLine":{"defaultValue":null,"description":"The CSS `text-decoration-line` property","name":"textDecorationLine","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textDecorationStyle":{"defaultValue":null,"description":"The CSS `text-decoration-style` property","name":"textDecorationStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textDecorationThickness":{"defaultValue":null,"description":"The CSS `text-decoration-thickness` property","name":"textDecorationThickness","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"textIndent":{"defaultValue":null,"description":"The CSS `text-indent` property","name":"textIndent","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"textOverflow":{"defaultValue":null,"description":"The CSS `text-overflow` property","name":"textOverflow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textShadow":{"defaultValue":null,"description":"The `text-shadow` property","name":"textShadow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textTransform":{"defaultValue":null,"description":"The CSS `text-transform` property","name":"textTransform","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textUnderlineOffset":{"defaultValue":null,"description":"The CSS `text-underline-offset` property","name":"textUnderlineOffset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"top":{"defaultValue":null,"description":"The CSS `top` property","name":"top","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"transform":{"defaultValue":null,"description":"The CSS `transform` property","name":"transform","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue<\"auto\" | Transform | \"auto-gpu\">"}},"transformOrigin":{"defaultValue":null,"description":"The CSS `transform-origin` property","name":"transformOrigin","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"transitionDelay":{"defaultValue":null,"description":"The CSS `transition-delay` property","name":"transitionDelay","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"transitionDuration":{"defaultValue":null,"description":"The CSS `transition-duration` property","name":"transitionDuration","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"transitionProperty":{"defaultValue":null,"description":"The CSS `transition-property` property","name":"transitionProperty","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"transitionTimingFunction":{"defaultValue":null,"description":"The CSS `transition-timing-function` property","name":"transitionTimingFunction","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"userSelect":{"defaultValue":null,"description":"The CSS `user-select` property","name":"userSelect","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"verticalAlign":{"defaultValue":null,"description":"The CSS `vertical-align` property","name":"verticalAlign","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"visibility":{"defaultValue":null,"description":"The CSS `visibility` property","name":"visibility","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"whiteSpace":{"defaultValue":null,"description":"The CSS `white-space` property","name":"whiteSpace","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"width":{"defaultValue":null,"description":"The CSS `width` property","name":"width","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"willChange":{"defaultValue":null,"description":"The CSS `will-change` property","name":"willChange","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"wordBreak":{"defaultValue":null,"description":"The CSS `word-break` property","name":"wordBreak","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"zIndex":{"defaultValue":null,"description":"The CSS `z-index` property","name":"zIndex","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue<\"base\" | \"banner\" | \"tooltip\" | \"overlay\" | ZIndex | \"hide\" | \"docked\" | \"dropdown\" | \"sticky\" | \"modal\" | \"popover\" | \"skipLink\" | \"toast\">"}},"animation":{"defaultValue":null,"description":"The CSS `animation` property","name":"animation","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransitionProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"background":{"defaultValue":null,"description":"The CSS `background` property","name":"background","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"backgroundPosition":{"defaultValue":null,"description":"The CSS `background-position` property","name":"backgroundPosition","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"border":{"defaultValue":null,"description":"The CSS `border` property","name":"border","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlock":{"defaultValue":null,"description":"","name":"borderBlock","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockEnd":{"defaultValue":null,"description":"","name":"borderBlockEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBlockStart":{"defaultValue":null,"description":"","name":"borderBlockStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottom":{"defaultValue":null,"description":"The CSS `border-bottom` property","name":"borderBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderColor":{"defaultValue":null,"description":"The CSS `border-color` property","name":"borderColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | \"whiteAlpha.800\" | ... 212 more ... | BorderTopColor>"}},"borderInline":{"defaultValue":null,"description":"","name":"borderInline","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineEnd":{"defaultValue":null,"description":"","name":"borderInlineEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineStart":{"defaultValue":null,"description":"","name":"borderInlineStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderLeft":{"defaultValue":null,"description":"The CSS `border-left` property","name":"borderLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderRadius":{"defaultValue":null,"description":"The CSS `border-radius` property","name":"borderRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderRight":{"defaultValue":null,"description":"The CSS `border-right` property","name":"borderRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStyle":{"defaultValue":null,"description":"The CSS `border-style` property","name":"borderStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTop":{"defaultValue":null,"description":"The CSS `border-top` property","name":"borderTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderWidth":{"defaultValue":null,"description":"The CSS `border-width` property","name":"borderWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"flex":{"defaultValue":null,"description":"The CSS `flex` property.\n\nIt defines how a flex item will grow or shrink\nto fit the space available in its flex container.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex)","name":"flex","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"flexFlow":{"defaultValue":null,"description":"The CSS `flex-flow` property.\n\nIt is a shorthand property for `flex-direction` and `flex-wrap`.\nIt specifies the direction of a flex container, as well as its wrapping behavior.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-flow)","name":"flexFlow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gap":{"defaultValue":null,"description":"The CSS `gap` property.\n\nIt defines the gap between items in both flex and\ngrid contexts.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/gap)","name":"gap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"gridArea":{"defaultValue":null,"description":"The CSS `grid-areas` property.\n\nIt specifies a grid item’s size and location within a grid by\ncontributing a line, a span, or nothing (automatic)\nto its grid placement, thereby specifying the edges of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area)","name":"gridArea","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridColumn":{"defaultValue":null,"description":"The CSS `grid-column` property.\n\nIt specifies a grid item's size and location within a grid column\nby contributing a line, a span, or nothing (automatic) to its grid placement,\nthereby specifying the `inline-start` and `inline-end` edge of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column)","name":"gridColumn","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridRow":{"defaultValue":null,"description":"The CSS `grid-row` property\n\nIt specifies a grid item’s size and location within the grid row\nby contributing a line, a span, or nothing (automatic) to its grid placement,\nthereby specifying the `inline-start` and `inline-end` edge of its grid area.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row)","name":"gridRow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridTemplate":{"defaultValue":null,"description":"The CSS `grid-template` property.\n\nIt is a shorthand property for defining grid columns, rows, and areas.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template)","name":"gridTemplate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"margin":{"defaultValue":null,"description":"Margin on top, left, bottom and right","name":"margin","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"outline":{"defaultValue":null,"description":"The CSS `outline` property","name":"outline","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"InteractivityProps"}],"required":false,"type":{"name":"ResponsiveValue>"}},"overflow":{"defaultValue":null,"description":"The CSS `overflow` property","name":"overflow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscrollBehavior":{"defaultValue":null,"description":"The CSS `overscroll-behavior` property","name":"overscrollBehavior","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"padding":{"defaultValue":null,"description":"Padding on top, left, bottom and right","name":"padding","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"placeItems":{"defaultValue":null,"description":"The CSS `place-items` property.\n\nIt allows you to align items along both the block and\ninline directions at once (i.e. the align-items and justify-items properties)\nin a relevant layout system such as `Grid` or `Flex`.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-items)","name":"placeItems","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"placeSelf":{"defaultValue":null,"description":"The CSS `place-self` property.\n\nIt allows you to align an individual item in both the block and\ninline directions at once (i.e. the align-self and justify-self properties)\nin a relevant layout system such as Grid or Flexbox.\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-self)","name":"placeSelf","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textDecoration":{"defaultValue":null,"description":"The CSS `text-decoration` property","name":"textDecoration","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridColumnGap":{"defaultValue":null,"description":"The CSS `grid-column-gap` property.\n\nIt defines the size of the gap (gutter) between an element's columns.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/column-gap)","name":"gridColumnGap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridGap":{"defaultValue":null,"description":"The CSS `grid-gap` property.\n\nIt defines the gaps (gutters) between rows and columns\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-gap)","name":"gridGap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"gridRowGap":{"defaultValue":null,"description":"The CSS `grid-row-gap` property.\n\nIt defines the size of the gap (gutter) between an element's grid rows.\n@see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/row-gap)","name":"gridRowGap","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"GridProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"fill":{"defaultValue":null,"description":"The CSS `fill` property for icon svgs and paths","name":"fill","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"stroke":{"defaultValue":null,"description":"The CSS `stroke` property for icon svgs and paths","name":"stroke","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"translateX":{"defaultValue":null,"description":"Translate value of an elements in the x-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-translate-x`","name":"translateX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"translateY":{"defaultValue":null,"description":"Translate value of an elements in the y-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-translate-y`","name":"translateY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scaleX":{"defaultValue":null,"description":"Scale value of an elements in the x-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-scale-x`","name":"scaleX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scaleY":{"defaultValue":null,"description":"Scale value of an elements in the y-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-scale-y`","name":"scaleY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"skewX":{"defaultValue":null,"description":"Skew value of an elements in the x-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-skew-x`","name":"skewX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"skewY":{"defaultValue":null,"description":"Skew value of an elements in the y-direction.\n- Only works if `transform=auto`\n- It sets the value of `--chakra-skew-y`","name":"skewY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TransformProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"shadow":{"defaultValue":null,"description":"The `box-shadow` property","name":"shadow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"method":{"defaultValue":null,"description":"","name":"method","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"name":{"defaultValue":null,"description":"","name":"name","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"target":{"defaultValue":null,"description":"","name":"target","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"mode":{"defaultValue":null,"description":"","name":"mode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"keyof ValidationMode"}},"values":{"defaultValue":null,"description":"","name":"values","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"FieldValues"}},"m":{"defaultValue":null,"description":"Margin on top, left, bottom and right","name":"m","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"mt":{"defaultValue":null,"description":"Margin on top","name":"mt","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"mr":{"defaultValue":null,"description":"Margin on right","name":"mr","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginEnd":{"defaultValue":null,"description":"When direction is `ltr`, `marginEnd` is equivalent to `marginRight`.\nWhen direction is `rtl`, `marginEnd` is equivalent to `marginLeft`.","name":"marginEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"me":{"defaultValue":null,"description":"When direction is `ltr`, `me` is equivalent to `marginRight`.\nWhen direction is `rtl`, `me` is equivalent to `marginLeft`.","name":"me","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"mb":{"defaultValue":null,"description":"Margin on bottom","name":"mb","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ml":{"defaultValue":null,"description":"Margin on left","name":"ml","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginStart":{"defaultValue":null,"description":"When direction is `ltr`, `marginStart` is equivalent to `marginLeft`.\nWhen direction is `rtl`, `marginStart` is equivalent to `marginRight`.","name":"marginStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ms":{"defaultValue":null,"description":"When direction is `ltr`, `ms` is equivalent to `marginLeft`.\nWhen direction is `rtl`, `ms` is equivalent to `marginRight`.","name":"ms","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"mx":{"defaultValue":null,"description":"Margin on left and right","name":"mx","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginX":{"defaultValue":null,"description":"Margin on left and right","name":"marginX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"my":{"defaultValue":null,"description":"Margin on top and bottom","name":"my","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"marginY":{"defaultValue":null,"description":"Margin on top and bottom","name":"marginY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pt":{"defaultValue":null,"description":"Padding on top","name":"pt","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pr":{"defaultValue":null,"description":"Padding on right","name":"pr","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingEnd":{"defaultValue":null,"description":"When direction is `ltr`, `paddingEnd` is equivalent to `paddingRight`.\nWhen direction is `rtl`, `paddingEnd` is equivalent to `paddingLeft`.","name":"paddingEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pe":{"defaultValue":null,"description":"When direction is `ltr`, `pe` is equivalent to `paddingRight`.\nWhen direction is `rtl`, `pe` is equivalent to `paddingLeft`.","name":"pe","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pb":{"defaultValue":null,"description":"Padding on bottom","name":"pb","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pl":{"defaultValue":null,"description":"Padding on left","name":"pl","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingStart":{"defaultValue":null,"description":"When direction is `ltr`, `paddingStart` is equivalent to `paddingLeft`.\nWhen direction is `rtl`, `paddingStart` is equivalent to `paddingRight`.","name":"paddingStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ps":{"defaultValue":null,"description":"When direction is `ltr`, `ps` is equivalent to `paddingLeft`.\nWhen direction is `rtl`, `ps` is equivalent to `paddingRight`.","name":"ps","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"px":{"defaultValue":null,"description":"Padding on left and right","name":"px","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingX":{"defaultValue":null,"description":"Padding on left and right","name":"paddingX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"py":{"defaultValue":null,"description":"Padding on top and bottom","name":"py","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"paddingY":{"defaultValue":null,"description":"Padding on top and bottom","name":"paddingY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"SpaceProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textColor":{"defaultValue":null,"description":"The CSS `color` property","name":"textColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ColorProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"noOfLines":{"defaultValue":null,"description":"Used to truncate text at a specific number of lines","name":"noOfLines","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"isTruncated":{"defaultValue":null,"description":"If `true`, it clamps truncate a text after one line.","name":"isTruncated","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypographyProps"}],"required":false,"type":{"name":"boolean"}},"flexDir":{"defaultValue":null,"description":"The CSS `flex-direction` property.\n\nIt defines how flex items are placed in the flex container\ndefining the main axis and the direction (normal or reversed).\n@see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/flex-direction)","name":"flexDir","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FlexboxProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"blur":{"defaultValue":null,"description":"Sets the blur filter value of an element.\nValue is assigned to `--chakra-filter` css variable","name":"blur","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue<{} | \"base\" | \"none\" | (string & {}) | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\" | \"3xl\">"}},"brightness":{"defaultValue":null,"description":"Sets the brightness filter value of an element.\nValue is assigned to `--chakra-brightness` css variable","name":"brightness","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"contrast":{"defaultValue":null,"description":"Sets the contrast filter value of an element.\nValue is assigned to `--chakra-contrast` css variable","name":"contrast","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"hueRotate":{"defaultValue":null,"description":"Sets the hue-rotate filter value of an element.\nValue is assigned to `--chakra-hue-rotate` css variable","name":"hueRotate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"invert":{"defaultValue":null,"description":"Sets the invert filter value of an element.\nValue is assigned to `--chakra-invert` css variable","name":"invert","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"saturate":{"defaultValue":null,"description":"Sets the saturation filter value of an element.\nValue is assigned to `--chakra-saturate` css variable","name":"saturate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"dropShadow":{"defaultValue":null,"description":"Sets the drop-shadow filter value of an element.\nValue is assigned to `--chakra-drop-shadow` css variable","name":"dropShadow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue<\"base\" | \"outline\" | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\" | \"xs\" | BoxShadow | \"inner\" | \"dark-lg\">"}},"backdropBlur":{"defaultValue":null,"description":"Sets the backdrop-blur filter value of an element.\nValue is assigned to `--chakra-backdrop-blur` css variable","name":"backdropBlur","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue<{} | \"base\" | \"none\" | (string & {}) | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\" | \"3xl\">"}},"backdropBrightness":{"defaultValue":null,"description":"Sets the backdrop-brightness filter value of an element.\nValue is assigned to `--chakra-backdrop-brightness` css variable","name":"backdropBrightness","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backdropContrast":{"defaultValue":null,"description":"Sets the backdrop-contrast filter value of an element.\nValue is assigned to `--chakra-backdrop-contrast` css variable","name":"backdropContrast","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backdropHueRotate":{"defaultValue":null,"description":"Sets the backdrop-hue-rotate filter value of an element.\nValue is assigned to `--chakra-backdrop-hue-rotate` css variable","name":"backdropHueRotate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backdropInvert":{"defaultValue":null,"description":"Sets the backdrop-invert filter value of an element.\nValue is assigned to `--chakra-backdrop-invert` css variable","name":"backdropInvert","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"backdropSaturate":{"defaultValue":null,"description":"Sets the backdrop-saturate filter value of an element.\nValue is assigned to `--chakra-backdrop-saturate` css variable","name":"backdropSaturate","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"FilterProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"hideFrom":{"defaultValue":null,"description":"Hides an element from the specified breakpoint and up","name":"hideFrom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue<\"base\" | (string & {}) | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\">"}},"hideBelow":{"defaultValue":null,"description":"Hides an element below the specified breakpoint","name":"hideBelow","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue<\"base\" | (string & {}) | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"2xl\">"}},"w":{"defaultValue":null,"description":"The CSS `width` property","name":"w","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"boxSize":{"defaultValue":null,"description":"The CSS `width` and `height` property","name":"boxSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxW":{"defaultValue":null,"description":"The CSS `max-width` property","name":"maxW","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minW":{"defaultValue":null,"description":"The CSS `min-width` property","name":"minW","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"h":{"defaultValue":null,"description":"The CSS `height` property","name":"h","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"maxH":{"defaultValue":null,"description":"The CSS `max-height` property","name":"maxH","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"minH":{"defaultValue":null,"description":"The CSS `min-height` property","name":"minH","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscroll":{"defaultValue":null,"description":"The CSS `overscroll-behavior` property","name":"overscroll","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscrollX":{"defaultValue":null,"description":"The CSS `overscroll-behavior-x` property","name":"overscrollX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"overscrollY":{"defaultValue":null,"description":"The CSS `overscroll-behavior-y` property","name":"overscrollY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"LayoutProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"rounded":{"defaultValue":null,"description":"The CSS `border-radius` property","name":"rounded","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartWidth":{"defaultValue":null,"description":"","name":"borderStartWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndWidth":{"defaultValue":null,"description":"","name":"borderEndWidth","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartStyle":{"defaultValue":null,"description":"","name":"borderStartStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndStyle":{"defaultValue":null,"description":"","name":"borderEndStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartColor":{"defaultValue":null,"description":"","name":"borderStartColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndColor":{"defaultValue":null,"description":"","name":"borderEndColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEnd":{"defaultValue":null,"description":"","name":"borderEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStart":{"defaultValue":null,"description":"","name":"borderStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopRadius":{"defaultValue":null,"description":"The CSS `border-top-radius` property","name":"borderTopRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedTop":{"defaultValue":null,"description":"The CSS `border-top-radius` property","name":"roundedTop","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderRightRadius":{"defaultValue":null,"description":"The CSS `border-right-radius` property","name":"borderRightRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedRight":{"defaultValue":null,"description":"The CSS `border-right-radius` property","name":"roundedRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedEnd":{"defaultValue":null,"description":"When direction is `ltr`, `roundedEnd` is equivalent to `borderRightRadius`.\nWhen direction is `rtl`, `roundedEnd` is equivalent to `borderLeftRadius`.","name":"roundedEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineEndRadius":{"defaultValue":null,"description":"When direction is `ltr`, `borderInlineEndRadius` is equivalent to `borderRightRadius`.\nWhen direction is `rtl`, `borderInlineEndRadius` is equivalent to `borderLeftRadius`.","name":"borderInlineEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderEndRadius":{"defaultValue":null,"description":"When direction is `ltr`, `borderEndRadius` is equivalent to `borderRightRadius`.\nWhen direction is `rtl`, `borderEndRadius` is equivalent to `borderLeftRadius`.","name":"borderEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomRadius":{"defaultValue":null,"description":"The CSS `border-bottom-radius` property","name":"borderBottomRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedBottom":{"defaultValue":null,"description":"The CSS `border-bottom-radius` property","name":"roundedBottom","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderLeftRadius":{"defaultValue":null,"description":"The CSS `border-left-radius` property","name":"borderLeftRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedLeft":{"defaultValue":null,"description":"The CSS `border-left-radius` property","name":"roundedLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedStart":{"defaultValue":null,"description":"When direction is `ltr`, `roundedEnd` is equivalent to `borderRightRadius`.\nWhen direction is `rtl`, `roundedEnd` is equivalent to `borderLeftRadius`.","name":"roundedStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderInlineStartRadius":{"defaultValue":null,"description":"When direction is `ltr`, `borderInlineStartRadius` is equivalent to `borderLeftRadius`.\nWhen direction is `rtl`, `borderInlineStartRadius` is equivalent to `borderRightRadius`.","name":"borderInlineStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderStartRadius":{"defaultValue":null,"description":"When direction is `ltr`, `borderStartRadius` is equivalent to `borderLeftRadius`.\nWhen direction is `rtl`, `borderStartRadius` is equivalent to `borderRightRadius`.","name":"borderStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopStartRadius":{"defaultValue":null,"description":"","name":"borderTopStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedTopLeft":{"defaultValue":null,"description":"The CSS `border-top-left-radius` property","name":"roundedTopLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedTopStart":{"defaultValue":null,"description":"","name":"roundedTopStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderTopEndRadius":{"defaultValue":null,"description":"","name":"borderTopEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedTopRight":{"defaultValue":null,"description":"The CSS `border-top-right-radius` property","name":"roundedTopRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedTopEnd":{"defaultValue":null,"description":"","name":"roundedTopEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomStartRadius":{"defaultValue":null,"description":"","name":"borderBottomStartRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedBottomLeft":{"defaultValue":null,"description":"The CSS `border-bottom-left-radius` property","name":"roundedBottomLeft","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedBottomStart":{"defaultValue":null,"description":"","name":"roundedBottomStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderBottomEndRadius":{"defaultValue":null,"description":"","name":"borderBottomEndRadius","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedBottomRight":{"defaultValue":null,"description":"The CSS `border-bottom-right-radius` property","name":"roundedBottomRight","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"roundedBottomEnd":{"defaultValue":null,"description":"","name":"roundedBottomEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderX":{"defaultValue":null,"description":"The CSS `border-right` and `border-left` property","name":"borderX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"borderY":{"defaultValue":null,"description":"The CSS `border-top` and `border-bottom` property","name":"borderY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BorderProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"blendMode":{"defaultValue":null,"description":"The `blend-mode` property","name":"blendMode","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgBlendMode":{"defaultValue":null,"description":"The CSS `background-blend-mode` property","name":"bgBlendMode","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"EffectProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bg":{"defaultValue":null,"description":"The CSS `background` property","name":"bg","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"bgClip":{"defaultValue":null,"description":"The CSS `background-clip` property","name":"bgClip","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"text\" | BackgroundClip>"}},"bgColor":{"defaultValue":null,"description":"The CSS `background-color` property","name":"bgColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"bgGradient":{"defaultValue":null,"description":"The background-gradient shorthand","name":"bgGradient","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgPos":{"defaultValue":null,"description":"The CSS `background-position` property","name":"bgPos","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgImage":{"defaultValue":null,"description":"The CSS `background-image` property","name":"bgImage","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgImg":{"defaultValue":null,"description":"The CSS `background-image` property","name":"bgImg","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgRepeat":{"defaultValue":null,"description":"The CSS `background-repeat` property","name":"bgRepeat","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgSize":{"defaultValue":null,"description":"The CSS `background-size` property","name":"bgSize","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgAttachment":{"defaultValue":null,"description":"The CSS `background-attachment` property","name":"bgAttachment","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"bgPosition":{"defaultValue":null,"description":"The CSS `background-position` property","name":"bgPosition","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"BackgroundProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"listStylePos":{"defaultValue":null,"description":"The CSS `list-style-position` property","name":"listStylePos","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"listStyleImg":{"defaultValue":null,"description":"The CSS `list-style-image` property","name":"listStyleImg","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ListProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetEnd":{"defaultValue":null,"description":"When the direction is `ltr`, `insetEnd` is equivalent to `right`.\nWhen the direction is `rtl`, `insetEnd` is equivalent to `left`.","name":"insetEnd","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetStart":{"defaultValue":null,"description":"When the direction is `start`, `end` is equivalent to `left`.\nWhen the direction is `start`, `end` is equivalent to `right`.","name":"insetStart","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetX":{"defaultValue":null,"description":"The CSS `left`, and `right` property","name":"insetX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"insetY":{"defaultValue":null,"description":"The CSS `top`, and `bottom` property","name":"insetY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"pos":{"defaultValue":null,"description":"The CSS `position` property","name":"pos","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"PositionProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ring":{"defaultValue":null,"description":"Creates outline rings with CSS `box-shadow` property","name":"ring","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ringColor":{"defaultValue":null,"description":"The color of the outline ring","name":"ringColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"ringOffset":{"defaultValue":null,"description":"The thickness of the offset shadow when using outline rings","name":"ringOffset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"ringOffsetColor":{"defaultValue":null,"description":"The color of the offset shadow when adding outline rings","name":"ringOffsetColor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"}],"required":false,"type":{"name":"ResponsiveValue<\"current\" | Color | \"whiteAlpha.50\" | \"whiteAlpha.100\" | \"whiteAlpha.200\" | \"whiteAlpha.300\" | \"whiteAlpha.400\" | \"whiteAlpha.500\" | \"whiteAlpha.600\" | \"whiteAlpha.700\" | ... 212 more ... | \"muted\">"}},"ringInset":{"defaultValue":null,"description":"If the outline ring should an `inset`","name":"ringInset","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"RingProps"}],"required":false,"type":{"name":"ResponsiveValue<\"none\" | \"inset\">"}},"scrollMarginX":{"defaultValue":null,"description":"","name":"scrollMarginX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollMarginY":{"defaultValue":null,"description":"","name":"scrollMarginY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingX":{"defaultValue":null,"description":"","name":"scrollPaddingX","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"scrollPaddingY":{"defaultValue":null,"description":"","name":"scrollPaddingY","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"ScrollProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textDecor":{"defaultValue":null,"description":"The CSS `text-decoration` property","name":"textDecor","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TextDecorationProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"srOnly":{"defaultValue":null,"description":"If `true`, hide an element visually without hiding it from screen readers.\n\nIf `focusable`, the sr-only styles will be undone, making the element visible\nto sighted users as well as screen readers.","name":"srOnly","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"}],"required":false,"type":{"name":"true | \"focusable\""}},"layerStyle":{"defaultValue":null,"description":"The layer style object to apply.\nNote: Styles must be located in `theme.layerStyles`","name":"layerStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"textStyle":{"defaultValue":null,"description":"The text style object to apply.\nNote: Styles must be located in `theme.textStyles`","name":"textStyle","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"}],"required":false,"type":{"name":"ResponsiveValue<\"h1\" | \"h2\" | \"h3\" | (string & {}) | \"subtitle\">"}},"apply":{"defaultValue":null,"description":"Apply theme-aware style objects in `theme`\n@example ```jsx\nThis is a div\n```\n\nThis will apply styles defined in `theme.styles.h3`","name":"apply","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"OtherProps"}],"required":false,"type":{"name":"ResponsiveValue"}},"as":{"defaultValue":null,"description":"","name":"as","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"TypeLiteral"},{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"As"}},"_hover":{"defaultValue":null,"description":"Styles for CSS selector `&:hover`","name":"_hover","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_active":{"defaultValue":null,"description":"Styles for CSS Selector `&:active`","name":"_active","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_focus":{"defaultValue":null,"description":"Styles for CSS selector `&:focus`","name":"_focus","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_highlighted":{"defaultValue":null,"description":"Styles for the highlighted state.","name":"_highlighted","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_focusWithin":{"defaultValue":null,"description":"Styles to apply when a child of this element has received focus\n- CSS Selector `&:focus-within`","name":"_focusWithin","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_focusVisible":{"defaultValue":null,"description":"Styles to apply when this element has received focus via tabbing\n- CSS Selector `&:focus-visible`","name":"_focusVisible","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_disabled":{"defaultValue":null,"description":"Styles to apply when this element is disabled. The passed styles are applied to these CSS selectors:\n- `&[aria-disabled=true]`\n- `&:disabled`\n- `&[data-disabled]`\n- `&[disabled]`","name":"_disabled","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_readOnly":{"defaultValue":null,"description":"Styles for CSS Selector `&:readonly`","name":"_readOnly","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_before":{"defaultValue":null,"description":"Styles for CSS selector `&::before`\n\nNOTE:When using this, ensure the `content` is wrapped in a backtick.\n@example ```jsx\n\n```","name":"_before","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_after":{"defaultValue":null,"description":"Styles for CSS selector `&::after`\n\nNOTE:When using this, ensure the `content` is wrapped in a backtick.\n@example ```jsx\n\n```","name":"_after","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_empty":{"defaultValue":null,"description":"Styles for CSS selector `&:empty`","name":"_empty","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_expanded":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-expanded` is `true`\n- CSS selector `&[aria-expanded=true]`","name":"_expanded","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_checked":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-checked` is `true`\n- CSS selector `&[aria-checked=true]`","name":"_checked","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_grabbed":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-grabbed` is `true`\n- CSS selector `&[aria-grabbed=true]`","name":"_grabbed","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_pressed":{"defaultValue":null,"description":"Styles for CSS Selector `&[aria-pressed=true]`\nTypically used to style the current \"pressed\" state of toggle buttons","name":"_pressed","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_invalid":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-invalid` is `true`\n- CSS selector `&[aria-invalid=true]`","name":"_invalid","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_valid":{"defaultValue":null,"description":"Styles for the valid state\n- CSS selector `&[data-valid], &[data-state=valid]`","name":"_valid","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_loading":{"defaultValue":null,"description":"Styles for CSS Selector `&[aria-busy=true]` or `&[data-loading=true]`.\nUseful for styling loading states","name":"_loading","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_selected":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-selected` is `true`\n\n- CSS selector `&[aria-selected=true]`","name":"_selected","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_hidden":{"defaultValue":null,"description":"Styles for CSS Selector `[hidden=true]`","name":"_hidden","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_autofill":{"defaultValue":null,"description":"Styles for CSS Selector `&:-webkit-autofill`","name":"_autofill","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_even":{"defaultValue":null,"description":"Styles for CSS Selector `&:nth-child(even)`","name":"_even","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_odd":{"defaultValue":null,"description":"Styles for CSS Selector `&:nth-child(odd)`","name":"_odd","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_first":{"defaultValue":null,"description":"Styles for CSS Selector `&:first-of-type`","name":"_first","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_firstLetter":{"defaultValue":null,"description":"Styles for CSS selector `&::first-letter`\n\nNOTE: This selector is only applied for block-level elements and not preceded by an image or table.\n@example ```jsx\nOnce upon a time\n```","name":"_firstLetter","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_last":{"defaultValue":null,"description":"Styles for CSS Selector `&:last-of-type`","name":"_last","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_notFirst":{"defaultValue":null,"description":"Styles for CSS Selector `&:not(:first-of-type)`","name":"_notFirst","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_notLast":{"defaultValue":null,"description":"Styles for CSS Selector `&:not(:last-of-type)`","name":"_notLast","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_visited":{"defaultValue":null,"description":"Styles for CSS Selector `&:visited`","name":"_visited","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_activeLink":{"defaultValue":null,"description":"Used to style the active link in a navigation\nStyles for CSS Selector `&[aria-current=page]`","name":"_activeLink","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_activeStep":{"defaultValue":null,"description":"Used to style the current step within a process\nStyles for CSS Selector `&[aria-current=step]`","name":"_activeStep","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_indeterminate":{"defaultValue":null,"description":"Styles to apply when the ARIA attribute `aria-checked` is `mixed`\n- CSS selector `&[aria-checked=mixed]`","name":"_indeterminate","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupHover":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is hovered","name":"_groupHover","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerHover":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is hovered","name":"_peerHover","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupFocus":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is focused","name":"_groupFocus","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerFocus":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is focused","name":"_peerFocus","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupFocusVisible":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` has visible focus","name":"_groupFocusVisible","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerFocusVisible":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer`or `data-peer` has visible focus","name":"_peerFocusVisible","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupActive":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is active","name":"_groupActive","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerActive":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is active","name":"_peerActive","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupDisabled":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is disabled","name":"_groupDisabled","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerDisabled":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is disabled","name":"_peerDisabled","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupInvalid":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is invalid","name":"_groupInvalid","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerInvalid":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is invalid","name":"_peerInvalid","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupChecked":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` is checked","name":"_groupChecked","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerChecked":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` is checked","name":"_peerChecked","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_groupFocusWithin":{"defaultValue":null,"description":"Styles to apply when a parent element with `.group`, `data-group` or `role=group` has focus within","name":"_groupFocusWithin","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerFocusWithin":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` has focus within","name":"_peerFocusWithin","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_peerPlaceholderShown":{"defaultValue":null,"description":"Styles to apply when a sibling element with `.peer` or `data-peer` has placeholder shown","name":"_peerPlaceholderShown","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_placeholder":{"defaultValue":null,"description":"Styles for CSS Selector `&::placeholder`.","name":"_placeholder","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_placeholderShown":{"defaultValue":null,"description":"Styles for CSS Selector `&:placeholder-shown`.","name":"_placeholderShown","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_fullScreen":{"defaultValue":null,"description":"Styles for CSS Selector `&:fullscreen`.","name":"_fullScreen","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_selection":{"defaultValue":null,"description":"Styles for CSS Selector `&::selection`","name":"_selection","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_rtl":{"defaultValue":null,"description":"Styles for CSS Selector `[dir=rtl] &`\nIt is applied when a parent element or this element has `dir=\"rtl\"`","name":"_rtl","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_ltr":{"defaultValue":null,"description":"Styles for CSS Selector `[dir=ltr] &`\nIt is applied when a parent element or this element has `dir=\"ltr\"`","name":"_ltr","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_mediaDark":{"defaultValue":null,"description":"Styles for CSS Selector `@media (prefers-color-scheme: dark)`\nIt is used when the user has requested the system use a light or dark color theme.","name":"_mediaDark","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_mediaReduceMotion":{"defaultValue":null,"description":"Styles for CSS Selector `@media (prefers-reduced-motion: reduce)`\nIt is used when the user has requested the system to reduce the amount of animations.","name":"_mediaReduceMotion","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_dark":{"defaultValue":null,"description":"Styles for when `data-theme` is applied to any parent of\nthis component or element.","name":"_dark","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"_light":{"defaultValue":null,"description":"Styles for when `data-theme` is applied to any parent of\nthis component or element.","name":"_light","declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/styled-system/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"SystemStyleObject"}},"__css":{"defaultValue":null,"description":"Used for internal css management\n@private","name":"__css","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"}],"required":false,"type":{"name":"SystemStyleObject"}},"sx":{"defaultValue":null,"description":"Used to pass theme-aware style props.\nNB: This is the public API for user-land","name":"sx","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"}],"required":false,"type":{"name":"SystemStyleObject"}},"css":{"defaultValue":null,"description":"The emotion's css style object","name":"css","parent":{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"},"declarations":[{"fileName":"saas-ui/node_modules/@chakra-ui/system/dist/system.types.d.ts","name":"ChakraProps"}],"required":false,"type":{"name":"Interpolation<{}>"}},"action":{"defaultValue":null,"description":"","name":"action","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"autoComplete":{"defaultValue":null,"description":"","name":"autoComplete","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"shouldUnregister":{"defaultValue":null,"description":"","name":"shouldUnregister","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"reValidateMode":{"defaultValue":null,"description":"","name":"reValidateMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"\"onBlur\" | \"onChange\" | \"onSubmit\""}},"defaultValues":{"defaultValue":null,"description":"","name":"defaultValues","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"{ [x: string]: any; } | AsyncDefaultValues"}},"resetOptions":{"defaultValue":null,"description":"","name":"resetOptions","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepTouched: boolean; keepIsValid: boolean; keepSubmitCount: boolean; }>"}},"resolver":{"defaultValue":null,"description":"","name":"resolver","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Resolver"}},"context":{"defaultValue":null,"description":"","name":"context","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"object"}},"shouldFocusError":{"defaultValue":null,"description":"","name":"shouldFocusError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"shouldUseNativeValidation":{"defaultValue":null,"description":"","name":"shouldUseNativeValidation","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"criteriaMode":{"defaultValue":null,"description":"","name":"criteriaMode","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"CriteriaMode"}},"delayError":{"defaultValue":null,"description":"","name":"delayError","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/types/form.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}},"schema":{"defaultValue":null,"description":"The form schema.","name":"schema","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"any"}},"fieldResolver":{"defaultValue":null,"description":"The field resolver, used to resolve the fields from schemas.","name":"fieldResolver","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"FieldResolver"}},"fields":{"defaultValue":null,"description":"Field overrides","name":"fields","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"DefaultFieldOverrides"}},"acceptCharset":{"defaultValue":null,"description":"","name":"acceptCharset","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"encType":{"defaultValue":null,"description":"","name":"encType","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"string"}},"noValidate":{"defaultValue":null,"description":"","name":"noValidate","parent":{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"},"declarations":[{"fileName":"saas-ui/node_modules/@types/react/ts5.0/index.d.ts","name":"FormHTMLAttributes"}],"required":false,"type":{"name":"boolean"}},"formRef":{"defaultValue":null,"description":"The Hook Form state ref.","name":"formRef","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"FormOptions"}],"required":false,"type":{"name":"RefObject>"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useStepper.json b/tooling/props-docs/dist/components/useStepper.json new file mode 100644 index 000000000..7e4c4e392 --- /dev/null +++ b/tooling/props-docs/dist/components/useStepper.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"","displayName":"useStepper","methods":[],"props":{"step":{"defaultValue":null,"description":"","name":"step","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"string | number"}},"isCompleted":{"defaultValue":null,"description":"","name":"isCompleted","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"boolean"}},"onChange":{"defaultValue":null,"description":"","name":"onChange","parent":{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"UseStepperProps"}],"required":false,"type":{"name":"((index: number) => void)"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useStepperNextButton.json b/tooling/props-docs/dist/components/useStepperNextButton.json new file mode 100644 index 000000000..7eb82afc5 --- /dev/null +++ b/tooling/props-docs/dist/components/useStepperNextButton.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Returns props for a Next Button","displayName":"useStepperNextButton","methods":[],"props":{"label":{"defaultValue":null,"description":"","name":"label","declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}},"submitLabel":{"defaultValue":null,"description":"","name":"submitLabel","declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useStepperPrevButton.json b/tooling/props-docs/dist/components/useStepperPrevButton.json new file mode 100644 index 000000000..9b20c1df9 --- /dev/null +++ b/tooling/props-docs/dist/components/useStepperPrevButton.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Returns props for a Prev Button","displayName":"useStepperPrevButton","methods":[],"props":{"label":{"defaultValue":null,"description":"","name":"label","declarations":[{"fileName":"saas-ui/packages/saas-ui-core/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"string"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useSteps.json b/tooling/props-docs/dist/components/useSteps.json new file mode 100644 index 000000000..19e701839 --- /dev/null +++ b/tooling/props-docs/dist/components/useSteps.json @@ -0,0 +1 @@ +{"tags":{},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-hooks/src/index.ts","description":"","displayName":"useSteps","methods":[],"props":{"steps":{"defaultValue":null,"description":"","name":"steps","declarations":[{"fileName":"saas-ui/packages/saas-ui-hooks/src/use-steps.ts","name":"TypeLiteral"}],"required":true,"type":{"name":"S[]"}},"initialStep":{"defaultValue":{"value":0},"description":"","name":"initialStep","declarations":[{"fileName":"saas-ui/packages/saas-ui-hooks/src/use-steps.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"number"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/components/useWatch.json b/tooling/props-docs/dist/components/useWatch.json new file mode 100644 index 000000000..160bcb7b6 --- /dev/null +++ b/tooling/props-docs/dist/components/useWatch.json @@ -0,0 +1 @@ +{"tags":{"remarks":"[API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)\n[API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)\n[API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)\n[API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)","param":"props - defaultValue, disable subscription and match exact name.\nprops - defaultValue, disable subscription and match exact name.\nprops - defaultValue, disable subscription and match exact name.","example":"```tsx\nconst { watch } = useForm();\nconst values = useWatch({\n control,\n defaultValue: {\n name: \"data\"\n },\n exact: false,\n})\n```\n```tsx\nconst { watch } = useForm();\nconst values = useWatch({\n control,\n name: \"fieldA\",\n defaultValue: \"default value\",\n exact: false,\n})\n```\n```tsx\nconst { watch } = useForm();\nconst values = useWatch({\n control,\n name: [\"fieldA\", \"fieldB\"],\n defaultValue: {\n fieldA: \"data\",\n fieldB: \"data\"\n },\n exact: false,\n})\n```\n```tsx\n// can skip passing down the control into useWatch if the form is wrapped with the FormProvider\nconst values = useWatch()\n```"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Subscribe to the entire form values change and re-render at the hook level.\nCustom hook to subscribe to field change and isolate re-rendering at the component level.","displayName":"useWatch","methods":[],"props":{"defaultValue":{"defaultValue":null,"description":"","name":"defaultValue","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/useWatch.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"{ [x: string]: any; }"}},"control":{"defaultValue":null,"description":"","name":"control","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/useWatch.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"Control"}},"disabled":{"defaultValue":null,"description":"","name":"disabled","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/useWatch.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}},"exact":{"defaultValue":null,"description":"","name":"exact","declarations":[{"fileName":"saas-ui/node_modules/react-hook-form/dist/useWatch.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"boolean"}}}} \ No newline at end of file diff --git a/tooling/props-docs/dist/index.d.ts b/tooling/props-docs/dist/index.d.ts new file mode 100644 index 000000000..1789d04f7 --- /dev/null +++ b/tooling/props-docs/dist/index.d.ts @@ -0,0 +1,57 @@ +export interface Prop { + type: string + defaultValue?: string | null + required: boolean + description?: string +} + +export interface PropDoc { + [componentOrHook: string]: Prop +} + +export declare const Web3Address: PropDoc +export declare const Utils: PropDoc +export declare const Toolbar: PropDoc +export declare const Toggle: PropDoc +export declare const Timeline: PropDoc +export declare const StructuredList: PropDoc +export declare const Stepper: PropDoc +export declare const Src: PropDoc +export declare const Snackbar: PropDoc +export declare const Sidebar: PropDoc +export declare const SearchInput: PropDoc +export declare const Resize: PropDoc +export declare const Provider: PropDoc +export declare const Property: PropDoc +export declare const Persona: PropDoc +export declare const Page: PropDoc +export declare const Onboarding: PropDoc +export declare const Nprogress: PropDoc +export declare const Navbar: PropDoc +export declare const Modals: PropDoc +export declare const Menu: PropDoc +export declare const LoadingOverlay: PropDoc +export declare const Link: PropDoc +export declare const Kanban: PropDoc +export declare const IconBadge: PropDoc +export declare const Hotkeys: PropDoc +export declare const Hooks: PropDoc +export declare const Forms: PropDoc +export declare const Filters: PropDoc +export declare const FileUpload: PropDoc +export declare const FeatureFlags: PropDoc +export declare const ErrorBoundary: PropDoc +export declare const EmptyState: PropDoc +export declare const DatePicker: PropDoc +export declare const DataTable: PropDoc +export declare const DataGrid: PropDoc +export declare const CommandBar: PropDoc +export declare const Charts: PropDoc +export declare const BulkActions: PropDoc +export declare const Banner: PropDoc +export declare const Auth: PropDoc +export declare const AppShell: PropDoc + +export declare const allPropDocs: Record + +export declare function getPropDoc(name: string): PropDoc | undefined diff --git a/tooling/props-docs/dist/index.js b/tooling/props-docs/dist/index.js new file mode 100644 index 000000000..6a751f003 --- /dev/null +++ b/tooling/props-docs/dist/index.js @@ -0,0 +1,140 @@ +const Web3Address = require('./components/Web3Address.json') +const Utils = require('./components/Utils.json') +const Toolbar = require('./components/Toolbar.json') +const Toggle = require('./components/Toggle.json') +const Timeline = require('./components/Timeline.json') +const StructuredList = require('./components/StructuredList.json') +const Stepper = require('./components/Stepper.json') +const Src = require('./components/Src.json') +const Snackbar = require('./components/Snackbar.json') +const Sidebar = require('./components/Sidebar.json') +const SearchInput = require('./components/SearchInput.json') +const Resize = require('./components/Resize.json') +const Provider = require('./components/Provider.json') +const Property = require('./components/Property.json') +const Persona = require('./components/Persona.json') +const Page = require('./components/Page.json') +const Onboarding = require('./components/Onboarding.json') +const Nprogress = require('./components/Nprogress.json') +const Navbar = require('./components/Navbar.json') +const Modals = require('./components/Modals.json') +const Menu = require('./components/Menu.json') +const LoadingOverlay = require('./components/LoadingOverlay.json') +const Link = require('./components/Link.json') +const Kanban = require('./components/Kanban.json') +const IconBadge = require('./components/IconBadge.json') +const Hotkeys = require('./components/Hotkeys.json') +const Hooks = require('./components/Hooks.json') +const Forms = require('./components/Forms.json') +const Filters = require('./components/Filters.json') +const FileUpload = require('./components/FileUpload.json') +const FeatureFlags = require('./components/FeatureFlags.json') +const ErrorBoundary = require('./components/ErrorBoundary.json') +const EmptyState = require('./components/EmptyState.json') +const DatePicker = require('./components/DatePicker.json') +const DataTable = require('./components/DataTable.json') +const DataGrid = require('./components/DataGrid.json') +const CommandBar = require('./components/CommandBar.json') +const Charts = require('./components/Charts.json') +const BulkActions = require('./components/BulkActions.json') +const Banner = require('./components/Banner.json') +const Auth = require('./components/Auth.json') +const AppShell = require('./components/AppShell.json') + +const json = { + Web3Address, + Utils, + Toolbar, + Toggle, + Timeline, + StructuredList, + Stepper, + Src, + Snackbar, + Sidebar, + SearchInput, + Resize, + Provider, + Property, + Persona, + Page, + Onboarding, + Nprogress, + Navbar, + Modals, + Menu, + LoadingOverlay, + Link, + Kanban, + IconBadge, + Hotkeys, + Hooks, + Forms, + Filters, + FileUpload, + FeatureFlags, + ErrorBoundary, + EmptyState, + DatePicker, + DataTable, + DataGrid, + CommandBar, + Charts, + BulkActions, + Banner, + Auth, + AppShell, +} + +const allPropDocs = Object.fromEntries( + Object.values(json).flatMap((doc) => Object.entries(doc)) +) + +const getPropDoc = (name) => allPropDocs[name] + +module.exports = { + allPropDocs, + getPropDoc, + Web3Address, + Utils, + Toolbar, + Toggle, + Timeline, + StructuredList, + Stepper, + Src, + Snackbar, + Sidebar, + SearchInput, + Resize, + Provider, + Property, + Persona, + Page, + Onboarding, + Nprogress, + Navbar, + Modals, + Menu, + LoadingOverlay, + Link, + Kanban, + IconBadge, + Hotkeys, + Hooks, + Forms, + Filters, + FileUpload, + FeatureFlags, + ErrorBoundary, + EmptyState, + DatePicker, + DataTable, + DataGrid, + CommandBar, + Charts, + BulkActions, + Banner, + Auth, + AppShell, +} diff --git a/tooling/props-docs/dist/index.mjs b/tooling/props-docs/dist/index.mjs new file mode 100644 index 000000000..5cb2c5485 --- /dev/null +++ b/tooling/props-docs/dist/index.mjs @@ -0,0 +1,136 @@ +import Web3AddressJson from './components/Web3Address.json' +import UtilsJson from './components/Utils.json' +import ToolbarJson from './components/Toolbar.json' +import ToggleJson from './components/Toggle.json' +import TimelineJson from './components/Timeline.json' +import StructuredListJson from './components/StructuredList.json' +import StepperJson from './components/Stepper.json' +import SrcJson from './components/Src.json' +import SnackbarJson from './components/Snackbar.json' +import SidebarJson from './components/Sidebar.json' +import SearchInputJson from './components/SearchInput.json' +import ResizeJson from './components/Resize.json' +import ProviderJson from './components/Provider.json' +import PropertyJson from './components/Property.json' +import PersonaJson from './components/Persona.json' +import PageJson from './components/Page.json' +import OnboardingJson from './components/Onboarding.json' +import NprogressJson from './components/Nprogress.json' +import NavbarJson from './components/Navbar.json' +import ModalsJson from './components/Modals.json' +import MenuJson from './components/Menu.json' +import LoadingOverlayJson from './components/LoadingOverlay.json' +import LinkJson from './components/Link.json' +import KanbanJson from './components/Kanban.json' +import IconBadgeJson from './components/IconBadge.json' +import HotkeysJson from './components/Hotkeys.json' +import HooksJson from './components/Hooks.json' +import FormsJson from './components/Forms.json' +import FiltersJson from './components/Filters.json' +import FileUploadJson from './components/FileUpload.json' +import FeatureFlagsJson from './components/FeatureFlags.json' +import ErrorBoundaryJson from './components/ErrorBoundary.json' +import EmptyStateJson from './components/EmptyState.json' +import DatePickerJson from './components/DatePicker.json' +import DataTableJson from './components/DataTable.json' +import DataGridJson from './components/DataGrid.json' +import CommandBarJson from './components/CommandBar.json' +import ChartsJson from './components/Charts.json' +import BulkActionsJson from './components/BulkActions.json' +import BannerJson from './components/Banner.json' +import AuthJson from './components/Auth.json' +import AppShellJson from './components/AppShell.json' + +export const Web3Address = Web3AddressJson +export const Utils = UtilsJson +export const Toolbar = ToolbarJson +export const Toggle = ToggleJson +export const Timeline = TimelineJson +export const StructuredList = StructuredListJson +export const Stepper = StepperJson +export const Src = SrcJson +export const Snackbar = SnackbarJson +export const Sidebar = SidebarJson +export const SearchInput = SearchInputJson +export const Resize = ResizeJson +export const Provider = ProviderJson +export const Property = PropertyJson +export const Persona = PersonaJson +export const Page = PageJson +export const Onboarding = OnboardingJson +export const Nprogress = NprogressJson +export const Navbar = NavbarJson +export const Modals = ModalsJson +export const Menu = MenuJson +export const LoadingOverlay = LoadingOverlayJson +export const Link = LinkJson +export const Kanban = KanbanJson +export const IconBadge = IconBadgeJson +export const Hotkeys = HotkeysJson +export const Hooks = HooksJson +export const Forms = FormsJson +export const Filters = FiltersJson +export const FileUpload = FileUploadJson +export const FeatureFlags = FeatureFlagsJson +export const ErrorBoundary = ErrorBoundaryJson +export const EmptyState = EmptyStateJson +export const DatePicker = DatePickerJson +export const DataTable = DataTableJson +export const DataGrid = DataGridJson +export const CommandBar = CommandBarJson +export const Charts = ChartsJson +export const BulkActions = BulkActionsJson +export const Banner = BannerJson +export const Auth = AuthJson +export const AppShell = AppShellJson + +const json = { +Web3Address, +Utils, +Toolbar, +Toggle, +Timeline, +StructuredList, +Stepper, +Src, +Snackbar, +Sidebar, +SearchInput, +Resize, +Provider, +Property, +Persona, +Page, +Onboarding, +Nprogress, +Navbar, +Modals, +Menu, +LoadingOverlay, +Link, +Kanban, +IconBadge, +Hotkeys, +Hooks, +Forms, +Filters, +FileUpload, +FeatureFlags, +ErrorBoundary, +EmptyState, +DatePicker, +DataTable, +DataGrid, +CommandBar, +Charts, +BulkActions, +Banner, +Auth, +AppShell +} + +export const allPropDocs = Object.fromEntries( + Object.values(json).flatMap((doc) => Object.entries(doc)), +) + +export const getPropDoc = (name) => allPropDocs[name] \ No newline at end of file