Skip to content

Latest commit

 

History

History
2246 lines (2178 loc) · 167 KB

API.md

File metadata and controls

2246 lines (2178 loc) · 167 KB

@kelvininc/react-ui-components exports

Generated from public source entry points by the repository's docs:generate. Do not edit. Read the adjacent package.json for its version and installed declarations for signatures; Stencil wrapper props, events, slots and CSS properties are in the matching @kelvininc/ui-components/manifest.json. React-authored component contracts follow the export tables below.

@kelvininc/react-ui-components

Export Kind Description
COPY_TOOLTIP type
CUSTOM_TIME_RANGE_KEY type Custom interval key for time range picker.
CodeDiffEditorOptions type
CodeEditor type
CodeEditorOptions type
CodeEditorTheme type
CodeInstance type
Component type
Components type
ComputePositionConfig type
CssClassMap type
CustomCssClass type
CustomCssClass1 type
CustomForm type
DEFAULT_CODE_EDITOR_LANGUAGE type
DEFAULT_CODE_EDITOR_OPTIONS type
DEFAULT_DROPDOWN_POSITION_CONFIG type
DEFAULT_DROPDOWN_Z_INDEX value
DEFAULT_KELVIN_CODE_EDITOR_THEME type
DEFAULT_PORTAL_Z_INDEX value
DEFAULT_RELATIVE_TIME_OPTIONS_GROUPS type Default relative time option groups for the time picker component.
DateInput type
DateInputState type
DateTimeCalculation type Configuration for calculating a specific date/time relative to a reference point.
DayjsTimeRange type
EAbsoluteTimeError value
EAbsoluteTimePickerMode value
EAbsoluteTimePickerMode1 type
EActionButtonType value
EAlarmSeverity value
EAlertType value
EAnchorTarget value
EApplyDefaults value
EBadgeType value
ECodeEditorTheme value
EComponentSize value
EComponentSize1 type
ECopyToClipboardState value
ECreateOptionStatus value
EDateTimeInputTypeStyle value
EDescriptionPosition value
EIconName value
EIconName1 type
EIllustrationName value
EIllustrationName1 type
EInputFieldType value
EInputSource value
ERadioControlType value
ERadioControlType1 type
ERelativeTimeComparisonConfig value Defines how the time calculation should be done
ERelativeTimeInputMode value
ERelativeTimeRangeKey value Relative time range keys for predefined time periods.
EStepState value
ETabItemType value
ETagColor value
ETagState value
ETimePickerView value
EToasterIconTypeClass type
EToasterType value
EToggleState value
ETooltipPosition value
ETooltipPosition1 type
EUnitReference value Unit reference for relative time calculations. Defines whether to align to the start or end of a time unit.
EValidationState value
EValidationState1 type
Element type The `@Element()` decorator is a reference to the actual host element once it has rendered.
Event type Components can emit data and events using the Event Emitter decorator. To dispatch Custom DOM events for other components to handle, use the `@Event()` decorator. The Event decorator also makes it easier for Stencil to automatically build types and documentation for the event data. https://stenciljs.com/docs/events
FontsApi type
HostAttributes type Host
IAbsoluteSelectedRangeDates type
IAbsoluteTimeDateTimeInputConfig type The subset of `kv-date-time-input` props that can be customized on the picker's inputs. Props the component controls internally (value, date format, input mask, focus, style, disabled state and the dropdown toggle icon) are intentionally excluded because overriding them would break the picker.
IAbsoluteTimeLimits type
IAbsoluteTimePicker type
IAbsoluteTimePickerDropdown type
IAbsoluteTimePickerDropdownEvents type
IAbsoluteTimePickerDropdownInput type
IAbsoluteTimePickerDropdownInputEvents type
IAbsoluteTimePickerEvents type
IActionButtonSplitConfig type
IActionButtonTextConfig type
IActionMenuHandle type
IActionMenuItem type
IActionMenuProps type
IAlertConfig type
IAlertEvents type
IBadge type
IBreadcrumbItem type
IBreadcrumbItemEvents type
IBuildSelectOptionsParams type
IButton type
IButtonEvents type
IButtonMenuState type
IButtonSplitEvents type
ICalendar type
ICalendarDay type
ICalendarDayEvents type
ICalendarEvents type
IChangeMonthEvent type
IChangeYearEvent type
ICheckbox type
ICheckboxEvents type
IClickDateEvent type
ICodeDiffEditorProps type
ICodeEditorProps type Configure the editor value, appearance and instance callbacks.
ICopyToClipboard type
ICreateOptionState type
ICreateOptionState1 type
ICustomCss type
IDateTimeInput type
IDateTimeInputEvents type
IDateTimeRangeFormatter type Formatter configuration for displaying date/time ranges.
IDescriptionList type
IDescriptionListItem type
IDescriptionListItemPopover type
IDescriptionListItemToggletipConfig type
IDropdown type
IDropdownBase type
IDropdownBaseEvents type
IDropdownEvents type
IFontOptions type
IIllustrationMessage type
IIllustrationMessage1 type
IInputWrapper type
IInputWrapperEvents type
ILink type
IModalConfig type
IModalController type
IModalEvents type
IMultiSelectDropdown type
IMultiSelectDropdownEvents type
IPortal type
IPortalEvents type
IRadio type
IRadioEvents type
IRadioList type
IRadioListEvents type
IRadioListItem type
IRadioListItemEvents type
IRange type
IRangeEvents type
IRelativeTimeDropdownOption type
IRelativeTimeInput type
IRelativeTimePicker type
IRelativeTimePickerEvents type
IRelativeTimePickerOption type
ISearch type
ISearchEvents type
ISelect type
ISelectCreateOption type
ISelectCreateOption1 type
ISelectCreateOptionEvents type
ISelectEvents type
ISelectMultiOption type
ISelectMultiOptions type
ISelectMultiOptionsConfig type
ISelectMultiOptionsEvents type
ISelectNavigationConfig type
ISelectOption type
ISelectOptionAction type
ISelectOptionEvents type
ISelectOptionWithChildren type
ISelectOptionsWithChildren type
ISelectSingleOption type
ISelectSingleOptions type
ISelectedTabIndicatorConfig type
ISingleSelectDropdown type
ISingleSelectDropdownEvents type
IStepBar type
IStepBarEvents type
IStepBarStep type
IStepBarStep1 type
IStepIndicator type
IStepIndicatorEvents type
IStepProgressBar type
ISwitchButton type
ISwitchButtonEvents type
ITabNavigationConfig type
ITabNavigationEvents type
ITabNavigationItem type
ITabNotification type
ITagStatus type
ITextField type
ITextField1 type
ITextFieldEvents type
ITimePicker type
ITimePickerEvents type
ITimePickerRelativeTime type
ITimePickerSelectOption type
ITimePickerSelectOptionEvents type
ITimePickerTime type
ITimePickerTimeState type
ITimePickerTimezone type
ITimePickerTimezone1 type
ITimezoneOffset type
ITimezoneOffset1 type
IToaster type
IToasterController type
IToasterEvents type
IToggleButton type
IToggleButtonEvents type
IToggleButtonGroup type
IToggleButtonGroupEvents type
IToggleSwitch type
IToggleSwitchEvents type
IToggleSwitchOption type
IToggleTip type
IToggleTipEvents type
ITooltip type
ITooltip1 type
ITooltipText type
ITypedDates type
IVirtualizedList type
IWizard type
IWizardEvents type
IWizardFooter type
IWizardFooterEvents type
IWizardHeader type
IWizardStep type
JSX type
KvAbsoluteTimePickerCustomEvent type
KvAbsoluteTimePickerDropdownCustomEvent type
KvAbsoluteTimePickerDropdownInputCustomEvent type
KvActionButtonCustomEvent type
KvActionButtonIconCustomEvent type
KvActionButtonMagicCustomEvent type
KvActionButtonSplitCustomEvent type
KvActionButtonTextCustomEvent type
KvActionMenu type An icon button that opens a menu of actions, with the menu button keyboard pattern: Enter, Space or ArrowDown open it on the first enabled action, the arrows, Home and End move between enabled actions, and Escape or Tab close it from the trigger. `kv-dropdown-base` moves the menu panel into a body portal, outside React's root, where React's delegated events never arrive. So the panel's listeners are native ones.
KvAlertCustomEvent type
KvBreadcrumbCustomEvent type
KvBreadcrumbItemCustomEvent type
KvBreadcrumbListCustomEvent type
KvCalendarCustomEvent type
KvCalendarDayCustomEvent type
KvCheckboxCustomEvent type
KvCodeDiffEditor type
KvCodeEditor type
KvDateTimeInputCustomEvent type
KvDropdownBaseCustomEvent type
KvDropdownCustomEvent type
KvInlineEditableFieldCustomEvent type
KvInputWrapperCustomEvent type
KvLinkCustomEvent type
KvModalCustomEvent type
KvMultiSelectDropdownCustomEvent type
KvPortalCustomEvent type
KvRadioCustomEvent type
KvRadioListCustomEvent type
KvRadioListItemCustomEvent type
KvRangeCustomEvent type
KvRelativeTimePickerCustomEvent type
KvSchemaForm type
KvSearchCustomEvent type
KvSelectCreateOptionCustomEvent type
KvSelectCustomEvent type
KvSelectMultiOptionsCustomEvent type
KvSelectOptionCustomEvent type
KvSingleSelectDropdownCustomEvent type
KvStepBarCustomEvent type
KvStepIndicatorCustomEvent type
KvSwitchButtonCustomEvent type
KvTabItemCustomEvent type
KvTabNavigationCustomEvent type
KvTextAreaCustomEvent type
KvTextFieldCustomEvent type
KvTimePickerCustomEvent type
KvTimePickerSelectOptionCustomEvent type
KvToasterCustomEvent type
KvToggleButtonCustomEvent type
KvToggleButtonGroupCustomEvent type
KvToggleSwitchCustomEvent type
KvToggleTipCustomEvent type
KvWizardCustomEvent type
KvWizardFooterCustomEvent type
MONACO_FONT_FAMILY type
MONACO_FONT_SIZE type
ModalOverlay type
ModalOverlayProps type
NormalizeEnumsResult type
OnCodeEditorChange type
RELATIVE_TIME_OFFSETS type Configuration mapping for all relative time range keys.
RelativeTimeOffsetConfig type Configuration for relative time offset calculations.
RenderItemFunc type
SchemaFormContext type
SchemaFormProps type
SelectedRange type
SelectedTime type
SelectedTimeState type
SelectedTimestamp type
SingleTime type
StepState type
StyleMode type
TIMEZONES type
TOGGLE_TIP_Z_INDEX value
TOOLTIP_Z_INDEX value
TimeRange type
TimeRangeCalendarKeys type Type for time range calendar keys.
TimestampRange type
ToasterContainer type
ToasterContainerProps type
UIComponentsConfig type
areDatesValid type
arraysHelper value
buildAbsoluteAmountOfUnitsConfigRange type
buildAllOptionsSelected type
buildDayjsRange type Builds the range of the start and end date and returns the range array, ordering the dates if needed
buildDefaultFormStateBehavior value
buildOptionRange type Date range builders
buildPartialOptionsSelected type
buildRelativeAmountOfUnitsConfigRange type
buildRelativeTimeOption type Builder function to create IRelativeTimePickerOption with automatic startDate/endDate derivation from RELATIVE_TIME_OFFSETS.
buildSelectedOptions type
buildSingleDateConfigRange type
buildStartDateEndDateConfigRange type
buildTimestampRange type
buildTimezoneByOffset type
calculateOffsetDate type
cleanUnsupportedSchemaKeys value
clipboardHelper value
copyTextToClipboard type
cssClassHelper value
dateHelper value
didClickOnElement type
fallbackCopyTextToClipboard type
flattenSelectOptionsArray type
floatingUIHelper value
formatDate type
formatDateTime type
formatForTimezone type
formatTimezoneName type
fromDateFields type
fromDateInput type
fromISO type
generateForm type
getAbsoluteTimeRange type Returns the provided range in utc.
getArrayOfIndexes type
getClassList type
getClassMap type
getDateMonth type
getDateYear type
getDatesBetweenRange type
getDefaultTimezone type
getDefaultTimezoneSettings type
getDefaultTimezones type The offset-sorted catalogue of every timezone the platform knows about, built at most once per page. `buildTimezoneByOffset(getTimezonesNames())` walks ~418 IANA zones and makes two `dayjs().tz(zone)` calls for each, so a single evaluation costs ~45ms of `Intl.DateTimeFormat` construction. Use this instead of calling the pair directly in a `@Prop` initialiser: those run per component instance, so a picker rendered once per row of a table made mounting (or unmounting) the table a multi-second blocking task. Offsets are resolved for "now", so a page left open across a DST transition keeps the offsets it started with. That was already true of any instance mounted before the transition, and one shared snapshot beats paying for a fresh one on every mount. Callers must treat the result as read-only — it is shared by every component that defaults to it.
getDefaultValidator value
getFirstWeekdayIndexOfMonth type
getFlattenSelectOptions type
getFlattenSelectOptionsArray type
getInitialFormData value
getMonthAndYearTitle type
getMonthName type
getNextEnabledIndex type Finds the enabled neighbor, wrapping and skipping disabled options. An unset origin starts at an end.
getNextHightlightableOption type
getNumberOfDaysInMonth type
getPreviousHightlightableOption type
getRelativeTimeCalculation type Derives DateTimeCalculation configuration from a relative time range key. This eliminates manual duplication of offset data.
getRelativeTimeOption type Finds a relative time option by its key from the provided options groups.
getRelativeTimeRangeISO type Returns a start and end time according to a relative time range in utc.
getRelativeTimeRangeName type
getRelativeTimeRangeTimestamp type Returns a start and end time according to a relative time range as timestamps.
getScrollBottom type
getScrollLeft type
getScrollRight type
getScrollTop type
getSelectableOptions type
getSelectableOptionsFromArray type
getSelectedCount type
getSelectedSelectableOptions type
getSlotElements type
getThemeMode type Gets the current theme mode.
getTimezoneOffset type
getTimezonesNames type
getUTF8StringLength type
getWeekdaysNames type
initialize value
isDateAfter type
isDateBefore type
isDateInArray type
isDateInRange type
isDateSame type
isDateTimeAfter type
isDateTimeBefore type
isDateValid type
isSubString type
isTargetOnElement type
isValidLabel type
mergeComputePositionConfigs type
mouseEventHelper value
newDate type Helper methods for date type display, parse, calculate and manipulation.
newTimezoneDate type
newTimezoneDateFromFormat type
normalizeEnums value Collapses simple `oneOf` constructs into an equivalent `{ enum: [...] }`, moving everything the branches carried into the uiSchema: titles to `ui:enumNames`, disabled options to `ui:enumDisabled` and per-option descriptions to `ui:enumDescriptions`. This is not cosmetic. AJV compiles `oneOf` as one nested `else` per branch, so an option list built from instance data — every asset, every data stream — produces a validator nested as deeply as the list, and `new Function` overflows the parser stack. `enum` compiles to a single loop instead. The protection reaches only option lists that sit at a static uiSchema path. A list inside a union branch, or behind a `$ref` into `definitions`, is left as a `oneOf` and can still reach AJV: the same definition may be referenced from several properties, and two union branches may name the same property, so there is no single path its titles could be written to. Collapsing those needs reference- and branch-aware traversal, which this does not attempt.
normalizeSchema value Normalizes a JSON schema by applying various transformations.
relativeTimeHelper value
searchDropdownOptions type
searchHelper value
searchString type
selectHelper value
setThemeMode type Dynamically sets the theme mode without requiring a page refresh. This updates the mode attribute on the body element, which triggers CSS custom properties to update across all components.
stringHelper value
toggleThemeMode type Toggles between light and dark theme modes.
useFontsApi type
useModal type
useSchemaFormFocusRef type Registers the editable control in a widget, including a custom native input or Kelvin host.
useScroll type
useToaster type
validateRelativeTimeOffsets type Validates that all keys in RELATIVE_TIME_OFFSETS are valid enum values. Useful for development/testing to ensure consistency.

@kelvininc/react-ui-components/client

Export Kind Description
COPY_TOOLTIP type
CUSTOM_TIME_RANGE_KEY type Custom interval key for time range picker.
CodeDiffEditorOptions type
CodeEditor type
CodeEditorOptions type
CodeEditorTheme type
CodeInstance type
Component value
Components type
ComputePositionConfig type
CssClassMap type
CustomCssClass type
CustomCssClass1 type
CustomForm value
DEFAULT_CODE_EDITOR_LANGUAGE value
DEFAULT_CODE_EDITOR_OPTIONS value
DEFAULT_DROPDOWN_POSITION_CONFIG type
DEFAULT_DROPDOWN_Z_INDEX value
DEFAULT_KELVIN_CODE_EDITOR_THEME value
DEFAULT_PORTAL_Z_INDEX value
DEFAULT_RELATIVE_TIME_OPTIONS_GROUPS type Default relative time option groups for the time picker component.
DateInput type
DateInputState type
DateTimeCalculation type Configuration for calculating a specific date/time relative to a reference point.
DayjsTimeRange type
EAbsoluteTimeError value
EAbsoluteTimePickerMode value
EAbsoluteTimePickerMode1 type
EActionButtonType value
EAlarmSeverity value
EAlertType value
EAnchorTarget value
EApplyDefaults value
EBadgeType value
ECodeEditorTheme value
EComponentSize value
EComponentSize1 type
ECopyToClipboardState value
ECreateOptionStatus value
EDateTimeInputTypeStyle value
EDescriptionPosition value
EIconName value
EIconName1 type
EIllustrationName value
EIllustrationName1 type
EInputFieldType value
EInputSource value
ERadioControlType value
ERadioControlType1 type
ERelativeTimeComparisonConfig value Defines how the time calculation should be done
ERelativeTimeInputMode value
ERelativeTimeRangeKey value Relative time range keys for predefined time periods.
EStepState value
ETabItemType value
ETagColor value
ETagState value
ETimePickerView value
EToasterIconTypeClass type
EToasterType value
EToggleState value
ETooltipPosition value
ETooltipPosition1 type
EUnitReference value Unit reference for relative time calculations. Defines whether to align to the start or end of a time unit.
EValidationState value
EValidationState1 type
Element type The `@Element()` decorator is a reference to the actual host element once it has rendered.
Event type Components can emit data and events using the Event Emitter decorator. To dispatch Custom DOM events for other components to handle, use the `@Event()` decorator. The Event decorator also makes it easier for Stencil to automatically build types and documentation for the event data. https://stenciljs.com/docs/events
FontsApi type
HostAttributes type Host
IAbsoluteSelectedRangeDates type
IAbsoluteTimeDateTimeInputConfig type The subset of `kv-date-time-input` props that can be customized on the picker's inputs. Props the component controls internally (value, date format, input mask, focus, style, disabled state and the dropdown toggle icon) are intentionally excluded because overriding them would break the picker.
IAbsoluteTimeLimits type
IAbsoluteTimePicker type
IAbsoluteTimePickerDropdown type
IAbsoluteTimePickerDropdownEvents type
IAbsoluteTimePickerDropdownInput type
IAbsoluteTimePickerDropdownInputEvents type
IAbsoluteTimePickerEvents type
IActionButtonSplitConfig type
IActionButtonTextConfig type
IActionMenuHandle type
IActionMenuItem type
IActionMenuProps type
IAlertConfig type
IAlertEvents type
IBadge type
IBreadcrumbItem type
IBreadcrumbItemEvents type
IBuildSelectOptionsParams type
IButton type
IButtonEvents type
IButtonMenuState type
IButtonSplitEvents type
ICalendar type
ICalendarDay type
ICalendarDayEvents type
ICalendarEvents type
IChangeMonthEvent type
IChangeYearEvent type
ICheckbox type
ICheckboxEvents type
IClickDateEvent type
ICodeDiffEditorProps type
ICodeEditorProps type Configure the editor value, appearance and instance callbacks.
ICopyToClipboard type
ICreateOptionState type
ICreateOptionState1 type
ICustomCss type
IDateTimeInput type
IDateTimeInputEvents type
IDateTimeRangeFormatter type Formatter configuration for displaying date/time ranges.
IDescriptionList type
IDescriptionListItem type
IDescriptionListItemPopover type
IDescriptionListItemToggletipConfig type
IDropdown type
IDropdownBase type
IDropdownBaseEvents type
IDropdownEvents type
IFontOptions type
IIllustrationMessage type
IIllustrationMessage1 type
IInputWrapper type
IInputWrapperEvents type
ILink type
IModalConfig type
IModalController type
IModalEvents type
IMultiSelectDropdown type
IMultiSelectDropdownEvents type
IPortal type
IPortalEvents type
IRadio type
IRadioEvents type
IRadioList type
IRadioListEvents type
IRadioListItem type
IRadioListItemEvents type
IRange type
IRangeEvents type
IRelativeTimeDropdownOption type
IRelativeTimeInput type
IRelativeTimePicker type
IRelativeTimePickerEvents type
IRelativeTimePickerOption type
ISearch type
ISearchEvents type
ISelect type
ISelectCreateOption type
ISelectCreateOption1 type
ISelectCreateOptionEvents type
ISelectEvents type
ISelectMultiOption type
ISelectMultiOptions type
ISelectMultiOptionsConfig type
ISelectMultiOptionsEvents type
ISelectNavigationConfig type
ISelectOption type
ISelectOptionAction type
ISelectOptionEvents type
ISelectOptionWithChildren type
ISelectOptionsWithChildren type
ISelectSingleOption type
ISelectSingleOptions type
ISelectedTabIndicatorConfig type
ISingleSelectDropdown type
ISingleSelectDropdownEvents type
IStepBar type
IStepBarEvents type
IStepBarStep type
IStepBarStep1 type
IStepIndicator type
IStepIndicatorEvents type
IStepProgressBar type
ISwitchButton type
ISwitchButtonEvents type
ITabNavigationConfig type
ITabNavigationEvents type
ITabNavigationItem type
ITabNotification type
ITagStatus type
ITextField type
ITextField1 type
ITextFieldEvents type
ITimePicker type
ITimePickerEvents type
ITimePickerRelativeTime type
ITimePickerSelectOption type
ITimePickerSelectOptionEvents type
ITimePickerTime type
ITimePickerTimeState type
ITimePickerTimezone type
ITimePickerTimezone1 type
ITimezoneOffset type
ITimezoneOffset1 type
IToaster type
IToasterController type
IToasterEvents type
IToggleButton type
IToggleButtonEvents type
IToggleButtonGroup type
IToggleButtonGroupEvents type
IToggleSwitch type
IToggleSwitchEvents type
IToggleSwitchOption type
IToggleTip type
IToggleTipEvents type
ITooltip type
ITooltip1 type
ITooltipText type
ITypedDates type
IVirtualizedList type
IWizard type
IWizardEvents type
IWizardFooter type
IWizardFooterEvents type
IWizardHeader type
IWizardStep type
JSX type
KvAbsoluteTimePicker value
KvAbsoluteTimePickerCustomEvent type
KvAbsoluteTimePickerDropdown value
KvAbsoluteTimePickerDropdownCustomEvent type
KvAbsoluteTimePickerDropdownInput value
KvAbsoluteTimePickerDropdownInputCustomEvent type
KvActionButton value
KvActionButtonCustomEvent type
KvActionButtonIcon value
KvActionButtonIconCustomEvent type
KvActionButtonMagic value
KvActionButtonMagicCustomEvent type
KvActionButtonSplit value
KvActionButtonSplitCustomEvent type
KvActionButtonText value
KvActionButtonTextCustomEvent type
KvActionMenu value An icon button that opens a menu of actions, with the menu button keyboard pattern: Enter, Space or ArrowDown open it on the first enabled action, the arrows, Home and End move between enabled actions, and Escape or Tab close it from the trigger. `kv-dropdown-base` moves the menu panel into a body portal, outside React's root, where React's delegated events never arrive. So the panel's listeners are native ones.
KvAlert value
KvAlertCustomEvent type
KvBadge value
KvBreadcrumb value
KvBreadcrumbCustomEvent type
KvBreadcrumbItem value
KvBreadcrumbItemCustomEvent type
KvBreadcrumbList value
KvBreadcrumbListCustomEvent type
KvCalendar value
KvCalendarCustomEvent type
KvCalendarDay value
KvCalendarDayCustomEvent type
KvCheckbox value
KvCheckboxCustomEvent type
KvCodeDiffEditor value
KvCodeEditor value
KvCopyToClipboard value
KvDateTimeInput value
KvDateTimeInputCustomEvent type
KvDescriptionList value
KvDirtyDot value
KvDropdown value
KvDropdownBase value
KvDropdownBaseCustomEvent type
KvDropdownCustomEvent type
KvErrorState value
KvErrorState404 value
KvEsKelvinLogo value
KvEsKelvinLogotype value
KvFormHelpText value
KvFormLabel value
KvIcon value
KvIllustration value
KvIllustrationMessage value
KvImport value
KvInfoLabel value
KvInlineEditableField value
KvInlineEditableFieldCustomEvent type
KvInputWrapper value
KvInputWrapperCustomEvent type
KvLink value
KvLinkCustomEvent type
KvLoader value
KvModal value
KvModalCustomEvent type
KvMultiSelectDropdown value
KvMultiSelectDropdownCustomEvent type
KvNoContentHere value
KvNoDataAvailable value
KvNoMatchingResults value
KvNoResultsFound value
KvPortal value
KvPortalCustomEvent type
KvRadio value
KvRadioCustomEvent type
KvRadioList value
KvRadioListCustomEvent type
KvRadioListItem value
KvRadioListItemCustomEvent type
KvRange value
KvRangeCustomEvent type
KvRelativeTimePicker value
KvRelativeTimePickerCustomEvent type
KvSchemaForm value
KvSearch value
KvSearchCustomEvent type
KvSelect value
KvSelectCreateOption value
KvSelectCreateOptionCustomEvent type
KvSelectCustomEvent type
KvSelectMultiOptions value
KvSelectMultiOptionsCustomEvent type
KvSelectOption value
KvSelectOptionCustomEvent type
KvSelectShortcutsLabel value
KvSingleSelectDropdown value
KvSingleSelectDropdownCustomEvent type
KvStateIndicator value
KvStepBar value
KvStepBarCustomEvent type
KvStepIndicator value
KvStepIndicatorCustomEvent type
KvStepProgressBar value
KvSwitchButton value
KvSwitchButtonCustomEvent type
KvTabItem value
KvTabItemCustomEvent type
KvTabNavigation value
KvTabNavigationCustomEvent type
KvTag value
KvTagStatus value
KvTakeActions value
KvTextArea value
KvTextAreaCustomEvent type
KvTextField value
KvTextFieldCustomEvent type
KvTimePicker value
KvTimePickerCustomEvent type
KvTimePickerSelectOption value
KvTimePickerSelectOptionCustomEvent type
KvToaster value
KvToasterCustomEvent type
KvToggleButton value
KvToggleButtonCustomEvent type
KvToggleButtonGroup value
KvToggleButtonGroupCustomEvent type
KvToggleSwitch value
KvToggleSwitchCustomEvent type
KvToggleTip value
KvToggleTipCustomEvent type
KvTooltip value
KvTooltipText value
KvVirtualizedList value
KvWizard value
KvWizardCustomEvent type
KvWizardFooter value
KvWizardFooterCustomEvent type
KvWizardHeader value
MONACO_FONT_FAMILY value
MONACO_FONT_SIZE value
ModalOverlay value
ModalOverlayProps type
NormalizeEnumsResult type
OnCodeEditorChange type
RELATIVE_TIME_OFFSETS type Configuration mapping for all relative time range keys.
RelativeTimeOffsetConfig type Configuration for relative time offset calculations.
RenderItemFunc type
SchemaFormContext type
SchemaFormProps type
SelectedRange type
SelectedTime type
SelectedTimeState type
SelectedTimestamp type
SingleTime type
StepState type
StyleMode type
TIMEZONES type
TOGGLE_TIP_Z_INDEX value
TOOLTIP_Z_INDEX value
TimeRange type
TimeRangeCalendarKeys type Type for time range calendar keys.
TimestampRange type
ToasterContainer value
ToasterContainerProps type
UIComponentsConfig type
areDatesValid type
arraysHelper value
buildAbsoluteAmountOfUnitsConfigRange type
buildAllOptionsSelected type
buildDayjsRange type Builds the range of the start and end date and returns the range array, ordering the dates if needed
buildDefaultFormStateBehavior value
buildOptionRange type Date range builders
buildPartialOptionsSelected type
buildRelativeAmountOfUnitsConfigRange type
buildRelativeTimeOption type Builder function to create IRelativeTimePickerOption with automatic startDate/endDate derivation from RELATIVE_TIME_OFFSETS.
buildSelectedOptions type
buildSingleDateConfigRange type
buildStartDateEndDateConfigRange type
buildTimestampRange type
buildTimezoneByOffset type
calculateOffsetDate type
cleanUnsupportedSchemaKeys value
clipboardHelper value
copyTextToClipboard type
cssClassHelper value
dateHelper value
didClickOnElement type
fallbackCopyTextToClipboard type
flattenSelectOptionsArray type
floatingUIHelper value
formatDate type
formatDateTime type
formatForTimezone type
formatTimezoneName type
fromDateFields type
fromDateInput type
fromISO type
generateForm value
getAbsoluteTimeRange type Returns the provided range in utc.
getArrayOfIndexes type
getClassList type
getClassMap type
getDateMonth type
getDateYear type
getDatesBetweenRange type
getDefaultTimezone type
getDefaultTimezoneSettings type
getDefaultTimezones type The offset-sorted catalogue of every timezone the platform knows about, built at most once per page. `buildTimezoneByOffset(getTimezonesNames())` walks ~418 IANA zones and makes two `dayjs().tz(zone)` calls for each, so a single evaluation costs ~45ms of `Intl.DateTimeFormat` construction. Use this instead of calling the pair directly in a `@Prop` initialiser: those run per component instance, so a picker rendered once per row of a table made mounting (or unmounting) the table a multi-second blocking task. Offsets are resolved for "now", so a page left open across a DST transition keeps the offsets it started with. That was already true of any instance mounted before the transition, and one shared snapshot beats paying for a fresh one on every mount. Callers must treat the result as read-only — it is shared by every component that defaults to it.
getDefaultValidator value
getFirstWeekdayIndexOfMonth type
getFlattenSelectOptions type
getFlattenSelectOptionsArray type
getInitialFormData value
getMonthAndYearTitle type
getMonthName type
getNextEnabledIndex type Finds the enabled neighbor, wrapping and skipping disabled options. An unset origin starts at an end.
getNextHightlightableOption type
getNumberOfDaysInMonth type
getPreviousHightlightableOption type
getRelativeTimeCalculation type Derives DateTimeCalculation configuration from a relative time range key. This eliminates manual duplication of offset data.
getRelativeTimeOption type Finds a relative time option by its key from the provided options groups.
getRelativeTimeRangeISO type Returns a start and end time according to a relative time range in utc.
getRelativeTimeRangeName type
getRelativeTimeRangeTimestamp type Returns a start and end time according to a relative time range as timestamps.
getScrollBottom value
getScrollLeft value
getScrollRight value
getScrollTop value
getSelectableOptions type
getSelectableOptionsFromArray type
getSelectedCount type
getSelectedSelectableOptions type
getSlotElements type
getThemeMode type Gets the current theme mode.
getTimezoneOffset type
getTimezonesNames type
getUTF8StringLength type
getWeekdaysNames type
initialize value
isDateAfter type
isDateBefore type
isDateInArray type
isDateInRange type
isDateSame type
isDateTimeAfter type
isDateTimeBefore type
isDateValid type
isSubString type
isTargetOnElement type
isValidLabel type
mergeComputePositionConfigs type
mouseEventHelper value
newDate type Helper methods for date type display, parse, calculate and manipulation.
newTimezoneDate type
newTimezoneDateFromFormat type
normalizeEnums value Collapses simple `oneOf` constructs into an equivalent `{ enum: [...] }`, moving everything the branches carried into the uiSchema: titles to `ui:enumNames`, disabled options to `ui:enumDisabled` and per-option descriptions to `ui:enumDescriptions`. This is not cosmetic. AJV compiles `oneOf` as one nested `else` per branch, so an option list built from instance data — every asset, every data stream — produces a validator nested as deeply as the list, and `new Function` overflows the parser stack. `enum` compiles to a single loop instead. The protection reaches only option lists that sit at a static uiSchema path. A list inside a union branch, or behind a `$ref` into `definitions`, is left as a `oneOf` and can still reach AJV: the same definition may be referenced from several properties, and two union branches may name the same property, so there is no single path its titles could be written to. Collapsing those needs reference- and branch-aware traversal, which this does not attempt.
normalizeSchema value Normalizes a JSON schema by applying various transformations.
relativeTimeHelper value
searchDropdownOptions type
searchHelper value
searchString type
selectHelper value
setThemeMode type Dynamically sets the theme mode without requiring a page refresh. This updates the mode attribute on the body element, which triggers CSS custom properties to update across all components.
stringHelper value
toggleThemeMode type Toggles between light and dark theme modes.
useFontsApi value
useModal value
useSchemaFormFocusRef value Registers the editable control in a widget, including a custom native input or Kelvin host.
useScroll value
useToaster value
validateRelativeTimeOffsets type Validates that all keys in RELATIVE_TIME_OFFSETS are valid enum values. Useful for development/testing to ensure consistency.

@kelvininc/react-ui-components/server

Export Kind Description
COPY_TOOLTIP type
CUSTOM_TIME_RANGE_KEY type Custom interval key for time range picker.
CodeDiffEditorOptions type
CodeEditor type
CodeEditorOptions type
CodeEditorTheme type
CodeInstance type
Component type
Components type
ComputePositionConfig type
CssClassMap type
CustomCssClass type
CustomCssClass1 type
CustomForm type
DEFAULT_CODE_EDITOR_LANGUAGE type
DEFAULT_CODE_EDITOR_OPTIONS type
DEFAULT_DROPDOWN_POSITION_CONFIG type
DEFAULT_DROPDOWN_Z_INDEX value
DEFAULT_KELVIN_CODE_EDITOR_THEME type
DEFAULT_PORTAL_Z_INDEX value
DEFAULT_RELATIVE_TIME_OPTIONS_GROUPS type Default relative time option groups for the time picker component.
DateInput type
DateInputState type
DateTimeCalculation type Configuration for calculating a specific date/time relative to a reference point.
DayjsTimeRange type
EAbsoluteTimeError value
EAbsoluteTimePickerMode value
EAbsoluteTimePickerMode1 type
EActionButtonType value
EAlarmSeverity value
EAlertType value
EAnchorTarget value
EApplyDefaults value
EBadgeType value
ECodeEditorTheme value
EComponentSize value
EComponentSize1 type
ECopyToClipboardState value
ECreateOptionStatus value
EDateTimeInputTypeStyle value
EDescriptionPosition value
EIconName value
EIconName1 type
EIllustrationName value
EIllustrationName1 type
EInputFieldType value
EInputSource value
ERadioControlType value
ERadioControlType1 type
ERelativeTimeComparisonConfig value Defines how the time calculation should be done
ERelativeTimeInputMode value
ERelativeTimeRangeKey value Relative time range keys for predefined time periods.
EStepState value
ETabItemType value
ETagColor value
ETagState value
ETimePickerView value
EToasterIconTypeClass type
EToasterType value
EToggleState value
ETooltipPosition value
ETooltipPosition1 type
EUnitReference value Unit reference for relative time calculations. Defines whether to align to the start or end of a time unit.
EValidationState value
EValidationState1 type
Element type The `@Element()` decorator is a reference to the actual host element once it has rendered.
Event type Components can emit data and events using the Event Emitter decorator. To dispatch Custom DOM events for other components to handle, use the `@Event()` decorator. The Event decorator also makes it easier for Stencil to automatically build types and documentation for the event data. https://stenciljs.com/docs/events
FontsApi type
HostAttributes type Host
IAbsoluteSelectedRangeDates type
IAbsoluteTimeDateTimeInputConfig type The subset of `kv-date-time-input` props that can be customized on the picker's inputs. Props the component controls internally (value, date format, input mask, focus, style, disabled state and the dropdown toggle icon) are intentionally excluded because overriding them would break the picker.
IAbsoluteTimeLimits type
IAbsoluteTimePicker type
IAbsoluteTimePickerDropdown type
IAbsoluteTimePickerDropdownEvents type
IAbsoluteTimePickerDropdownInput type
IAbsoluteTimePickerDropdownInputEvents type
IAbsoluteTimePickerEvents type
IActionButtonSplitConfig type
IActionButtonTextConfig type
IActionMenuHandle type
IActionMenuItem type
IActionMenuProps type
IAlertConfig type
IAlertEvents type
IBadge type
IBreadcrumbItem type
IBreadcrumbItemEvents type
IBuildSelectOptionsParams type
IButton type
IButtonEvents type
IButtonMenuState type
IButtonSplitEvents type
ICalendar type
ICalendarDay type
ICalendarDayEvents type
ICalendarEvents type
IChangeMonthEvent type
IChangeYearEvent type
ICheckbox type
ICheckboxEvents type
IClickDateEvent type
ICodeDiffEditorProps type
ICodeEditorProps type Configure the editor value, appearance and instance callbacks.
ICopyToClipboard type
ICreateOptionState type
ICreateOptionState1 type
ICustomCss type
IDateTimeInput type
IDateTimeInputEvents type
IDateTimeRangeFormatter type Formatter configuration for displaying date/time ranges.
IDescriptionList type
IDescriptionListItem type
IDescriptionListItemPopover type
IDescriptionListItemToggletipConfig type
IDropdown type
IDropdownBase type
IDropdownBaseEvents type
IDropdownEvents type
IFontOptions type
IIllustrationMessage type
IIllustrationMessage1 type
IInputWrapper type
IInputWrapperEvents type
ILink type
IModalConfig type
IModalController type
IModalEvents type
IMultiSelectDropdown type
IMultiSelectDropdownEvents type
IPortal type
IPortalEvents type
IRadio type
IRadioEvents type
IRadioList type
IRadioListEvents type
IRadioListItem type
IRadioListItemEvents type
IRange type
IRangeEvents type
IRelativeTimeDropdownOption type
IRelativeTimeInput type
IRelativeTimePicker type
IRelativeTimePickerEvents type
IRelativeTimePickerOption type
ISearch type
ISearchEvents type
ISelect type
ISelectCreateOption type
ISelectCreateOption1 type
ISelectCreateOptionEvents type
ISelectEvents type
ISelectMultiOption type
ISelectMultiOptions type
ISelectMultiOptionsConfig type
ISelectMultiOptionsEvents type
ISelectNavigationConfig type
ISelectOption type
ISelectOptionAction type
ISelectOptionEvents type
ISelectOptionWithChildren type
ISelectOptionsWithChildren type
ISelectSingleOption type
ISelectSingleOptions type
ISelectedTabIndicatorConfig type
ISingleSelectDropdown type
ISingleSelectDropdownEvents type
IStepBar type
IStepBarEvents type
IStepBarStep type
IStepBarStep1 type
IStepIndicator type
IStepIndicatorEvents type
IStepProgressBar type
ISwitchButton type
ISwitchButtonEvents type
ITabNavigationConfig type
ITabNavigationEvents type
ITabNavigationItem type
ITabNotification type
ITagStatus type
ITextField type
ITextField1 type
ITextFieldEvents type
ITimePicker type
ITimePickerEvents type
ITimePickerRelativeTime type
ITimePickerSelectOption type
ITimePickerSelectOptionEvents type
ITimePickerTime type
ITimePickerTimeState type
ITimePickerTimezone type
ITimePickerTimezone1 type
ITimezoneOffset type
ITimezoneOffset1 type
IToaster type
IToasterController type
IToasterEvents type
IToggleButton type
IToggleButtonEvents type
IToggleButtonGroup type
IToggleButtonGroupEvents type
IToggleSwitch type
IToggleSwitchEvents type
IToggleSwitchOption type
IToggleTip type
IToggleTipEvents type
ITooltip type
ITooltip1 type
ITooltipText type
ITypedDates type
IVirtualizedList type
IWizard type
IWizardEvents type
IWizardFooter type
IWizardFooterEvents type
IWizardHeader type
IWizardStep type
JSX type
KvAbsoluteTimePickerCustomEvent type
KvAbsoluteTimePickerDropdownCustomEvent type
KvAbsoluteTimePickerDropdownInputCustomEvent type
KvActionButtonCustomEvent type
KvActionButtonIconCustomEvent type
KvActionButtonMagicCustomEvent type
KvActionButtonSplitCustomEvent type
KvActionButtonTextCustomEvent type
KvActionMenu type An icon button that opens a menu of actions, with the menu button keyboard pattern: Enter, Space or ArrowDown open it on the first enabled action, the arrows, Home and End move between enabled actions, and Escape or Tab close it from the trigger. `kv-dropdown-base` moves the menu panel into a body portal, outside React's root, where React's delegated events never arrive. So the panel's listeners are native ones.
KvAlertCustomEvent type
KvBreadcrumbCustomEvent type
KvBreadcrumbItemCustomEvent type
KvBreadcrumbListCustomEvent type
KvCalendarCustomEvent type
KvCalendarDayCustomEvent type
KvCheckboxCustomEvent type
KvCodeDiffEditor type
KvCodeEditor type
KvDateTimeInputCustomEvent type
KvDropdownBaseCustomEvent type
KvDropdownCustomEvent type
KvInlineEditableFieldCustomEvent type
KvInputWrapperCustomEvent type
KvLinkCustomEvent type
KvModalCustomEvent type
KvMultiSelectDropdownCustomEvent type
KvPortalCustomEvent type
KvRadioCustomEvent type
KvRadioListCustomEvent type
KvRadioListItemCustomEvent type
KvRangeCustomEvent type
KvRelativeTimePickerCustomEvent type
KvSchemaForm type
KvSearchCustomEvent type
KvSelectCreateOptionCustomEvent type
KvSelectCustomEvent type
KvSelectMultiOptionsCustomEvent type
KvSelectOptionCustomEvent type
KvSingleSelectDropdownCustomEvent type
KvStepBarCustomEvent type
KvStepIndicatorCustomEvent type
KvSwitchButtonCustomEvent type
KvTabItemCustomEvent type
KvTabNavigationCustomEvent type
KvTextAreaCustomEvent type
KvTextFieldCustomEvent type
KvTimePickerCustomEvent type
KvTimePickerSelectOptionCustomEvent type
KvToasterCustomEvent type
KvToggleButtonCustomEvent type
KvToggleButtonGroupCustomEvent type
KvToggleSwitchCustomEvent type
KvToggleTipCustomEvent type
KvWizardCustomEvent type
KvWizardFooterCustomEvent type
MONACO_FONT_FAMILY type
MONACO_FONT_SIZE type
ModalOverlay type
ModalOverlayProps type
NormalizeEnumsResult type
OnCodeEditorChange type
RELATIVE_TIME_OFFSETS type Configuration mapping for all relative time range keys.
RelativeTimeOffsetConfig type Configuration for relative time offset calculations.
RenderItemFunc type
SchemaFormContext type
SchemaFormProps type
SelectedRange type
SelectedTime type
SelectedTimeState type
SelectedTimestamp type
SingleTime type
StepState type
StyleMode type
TIMEZONES type
TOGGLE_TIP_Z_INDEX value
TOOLTIP_Z_INDEX value
TimeRange type
TimeRangeCalendarKeys type Type for time range calendar keys.
TimestampRange type
ToasterContainer type
ToasterContainerProps type
UIComponentsConfig type
areDatesValid type
arraysHelper value
buildAbsoluteAmountOfUnitsConfigRange type
buildAllOptionsSelected type
buildDayjsRange type Builds the range of the start and end date and returns the range array, ordering the dates if needed
buildDefaultFormStateBehavior value
buildOptionRange type Date range builders
buildPartialOptionsSelected type
buildRelativeAmountOfUnitsConfigRange type
buildRelativeTimeOption type Builder function to create IRelativeTimePickerOption with automatic startDate/endDate derivation from RELATIVE_TIME_OFFSETS.
buildSelectedOptions type
buildSingleDateConfigRange type
buildStartDateEndDateConfigRange type
buildTimestampRange type
buildTimezoneByOffset type
calculateOffsetDate type
cleanUnsupportedSchemaKeys value
clipboardHelper value
copyTextToClipboard type
cssClassHelper value
dateHelper value
didClickOnElement type
fallbackCopyTextToClipboard type
flattenSelectOptionsArray type
floatingUIHelper value
formatDate type
formatDateTime type
formatForTimezone type
formatTimezoneName type
fromDateFields type
fromDateInput type
fromISO type
generateForm type
getAbsoluteTimeRange type Returns the provided range in utc.
getArrayOfIndexes type
getClassList type
getClassMap type
getDateMonth type
getDateYear type
getDatesBetweenRange type
getDefaultTimezone type
getDefaultTimezoneSettings type
getDefaultTimezones type The offset-sorted catalogue of every timezone the platform knows about, built at most once per page. `buildTimezoneByOffset(getTimezonesNames())` walks ~418 IANA zones and makes two `dayjs().tz(zone)` calls for each, so a single evaluation costs ~45ms of `Intl.DateTimeFormat` construction. Use this instead of calling the pair directly in a `@Prop` initialiser: those run per component instance, so a picker rendered once per row of a table made mounting (or unmounting) the table a multi-second blocking task. Offsets are resolved for "now", so a page left open across a DST transition keeps the offsets it started with. That was already true of any instance mounted before the transition, and one shared snapshot beats paying for a fresh one on every mount. Callers must treat the result as read-only — it is shared by every component that defaults to it.
getDefaultValidator value
getFirstWeekdayIndexOfMonth type
getFlattenSelectOptions type
getFlattenSelectOptionsArray type
getInitialFormData value
getMonthAndYearTitle type
getMonthName type
getNextEnabledIndex type Finds the enabled neighbor, wrapping and skipping disabled options. An unset origin starts at an end.
getNextHightlightableOption type
getNumberOfDaysInMonth type
getPreviousHightlightableOption type
getRelativeTimeCalculation type Derives DateTimeCalculation configuration from a relative time range key. This eliminates manual duplication of offset data.
getRelativeTimeOption type Finds a relative time option by its key from the provided options groups.
getRelativeTimeRangeISO type Returns a start and end time according to a relative time range in utc.
getRelativeTimeRangeName type
getRelativeTimeRangeTimestamp type Returns a start and end time according to a relative time range as timestamps.
getScrollBottom type
getScrollLeft type
getScrollRight type
getScrollTop type
getSelectableOptions type
getSelectableOptionsFromArray type
getSelectedCount type
getSelectedSelectableOptions type
getSlotElements type
getThemeMode type Gets the current theme mode.
getTimezoneOffset type
getTimezonesNames type
getUTF8StringLength type
getWeekdaysNames type
initialize value
isDateAfter type
isDateBefore type
isDateInArray type
isDateInRange type
isDateSame type
isDateTimeAfter type
isDateTimeBefore type
isDateValid type
isSubString type
isTargetOnElement type
isValidLabel type
mergeComputePositionConfigs type
mouseEventHelper value
newDate type Helper methods for date type display, parse, calculate and manipulation.
newTimezoneDate type
newTimezoneDateFromFormat type
normalizeEnums value Collapses simple `oneOf` constructs into an equivalent `{ enum: [...] }`, moving everything the branches carried into the uiSchema: titles to `ui:enumNames`, disabled options to `ui:enumDisabled` and per-option descriptions to `ui:enumDescriptions`. This is not cosmetic. AJV compiles `oneOf` as one nested `else` per branch, so an option list built from instance data — every asset, every data stream — produces a validator nested as deeply as the list, and `new Function` overflows the parser stack. `enum` compiles to a single loop instead. The protection reaches only option lists that sit at a static uiSchema path. A list inside a union branch, or behind a `$ref` into `definitions`, is left as a `oneOf` and can still reach AJV: the same definition may be referenced from several properties, and two union branches may name the same property, so there is no single path its titles could be written to. Collapsing those needs reference- and branch-aware traversal, which this does not attempt.
normalizeSchema value Normalizes a JSON schema by applying various transformations.
relativeTimeHelper value
searchDropdownOptions type
searchHelper value
searchString type
selectHelper value
setThemeMode type Dynamically sets the theme mode without requiring a page refresh. This updates the mode attribute on the body element, which triggers CSS custom properties to update across all components.
stringHelper value
toggleThemeMode type Toggles between light and dark theme modes.
useFontsApi type
useModal type
useSchemaFormFocusRef type Registers the editable control in a widget, including a custom native input or Kelvin host.
useScroll type
useToaster type
validateRelativeTimeOffsets type Validates that all keys in RELATIVE_TIME_OFFSETS are valid enum values. Useful for development/testing to ensure consistency.

@kelvininc/react-ui-components/shared

Export Kind Description
COPY_TOOLTIP type
CUSTOM_TIME_RANGE_KEY type Custom interval key for time range picker.
CodeDiffEditorOptions type
CodeEditor type
CodeEditorOptions type
CodeEditorTheme type
CodeInstance type
Component type
Components type
ComputePositionConfig type
CssClassMap type
CustomCssClass type
CustomCssClass1 type
CustomForm type
DEFAULT_CODE_EDITOR_LANGUAGE type
DEFAULT_CODE_EDITOR_OPTIONS type
DEFAULT_DROPDOWN_POSITION_CONFIG type
DEFAULT_DROPDOWN_Z_INDEX value
DEFAULT_KELVIN_CODE_EDITOR_THEME type
DEFAULT_PORTAL_Z_INDEX value
DEFAULT_RELATIVE_TIME_OPTIONS_GROUPS type Default relative time option groups for the time picker component.
DateInput type
DateInputState type
DateTimeCalculation type Configuration for calculating a specific date/time relative to a reference point.
DayjsTimeRange type
EAbsoluteTimeError value
EAbsoluteTimePickerMode value
EAbsoluteTimePickerMode1 type
EActionButtonType value
EAlarmSeverity value
EAlertType value
EAnchorTarget value
EApplyDefaults value
EBadgeType value
ECodeEditorTheme value
EComponentSize value
EComponentSize1 type
ECopyToClipboardState value
ECreateOptionStatus value
EDateTimeInputTypeStyle value
EDescriptionPosition value
EIconName value
EIconName1 type
EIllustrationName value
EIllustrationName1 type
EInputFieldType value
EInputSource value
ERadioControlType value
ERadioControlType1 type
ERelativeTimeComparisonConfig value Defines how the time calculation should be done
ERelativeTimeInputMode value
ERelativeTimeRangeKey value Relative time range keys for predefined time periods.
EStepState value
ETabItemType value
ETagColor value
ETagState value
ETimePickerView value
EToasterIconTypeClass type
EToasterType value
EToggleState value
ETooltipPosition value
ETooltipPosition1 type
EUnitReference value Unit reference for relative time calculations. Defines whether to align to the start or end of a time unit.
EValidationState value
EValidationState1 type
Element type The `@Element()` decorator is a reference to the actual host element once it has rendered.
Event type Components can emit data and events using the Event Emitter decorator. To dispatch Custom DOM events for other components to handle, use the `@Event()` decorator. The Event decorator also makes it easier for Stencil to automatically build types and documentation for the event data. https://stenciljs.com/docs/events
FontsApi type
HostAttributes type Host
IAbsoluteSelectedRangeDates type
IAbsoluteTimeDateTimeInputConfig type The subset of `kv-date-time-input` props that can be customized on the picker's inputs. Props the component controls internally (value, date format, input mask, focus, style, disabled state and the dropdown toggle icon) are intentionally excluded because overriding them would break the picker.
IAbsoluteTimeLimits type
IAbsoluteTimePicker type
IAbsoluteTimePickerDropdown type
IAbsoluteTimePickerDropdownEvents type
IAbsoluteTimePickerDropdownInput type
IAbsoluteTimePickerDropdownInputEvents type
IAbsoluteTimePickerEvents type
IActionButtonSplitConfig type
IActionButtonTextConfig type
IActionMenuHandle type
IActionMenuItem type
IActionMenuProps type
IAlertConfig type
IAlertEvents type
IBadge type
IBreadcrumbItem type
IBreadcrumbItemEvents type
IBuildSelectOptionsParams type
IButton type
IButtonEvents type
IButtonMenuState type
IButtonSplitEvents type
ICalendar type
ICalendarDay type
ICalendarDayEvents type
ICalendarEvents type
IChangeMonthEvent type
IChangeYearEvent type
ICheckbox type
ICheckboxEvents type
IClickDateEvent type
ICodeDiffEditorProps type
ICodeEditorProps type Configure the editor value, appearance and instance callbacks.
ICopyToClipboard type
ICreateOptionState type
ICreateOptionState1 type
ICustomCss type
IDateTimeInput type
IDateTimeInputEvents type
IDateTimeRangeFormatter type Formatter configuration for displaying date/time ranges.
IDescriptionList type
IDescriptionListItem type
IDescriptionListItemPopover type
IDescriptionListItemToggletipConfig type
IDropdown type
IDropdownBase type
IDropdownBaseEvents type
IDropdownEvents type
IFontOptions type
IIllustrationMessage type
IIllustrationMessage1 type
IInputWrapper type
IInputWrapperEvents type
ILink type
IModalConfig type
IModalController type
IModalEvents type
IMultiSelectDropdown type
IMultiSelectDropdownEvents type
IPortal type
IPortalEvents type
IRadio type
IRadioEvents type
IRadioList type
IRadioListEvents type
IRadioListItem type
IRadioListItemEvents type
IRange type
IRangeEvents type
IRelativeTimeDropdownOption type
IRelativeTimeInput type
IRelativeTimePicker type
IRelativeTimePickerEvents type
IRelativeTimePickerOption type
ISearch type
ISearchEvents type
ISelect type
ISelectCreateOption type
ISelectCreateOption1 type
ISelectCreateOptionEvents type
ISelectEvents type
ISelectMultiOption type
ISelectMultiOptions type
ISelectMultiOptionsConfig type
ISelectMultiOptionsEvents type
ISelectNavigationConfig type
ISelectOption type
ISelectOptionAction type
ISelectOptionEvents type
ISelectOptionWithChildren type
ISelectOptionsWithChildren type
ISelectSingleOption type
ISelectSingleOptions type
ISelectedTabIndicatorConfig type
ISingleSelectDropdown type
ISingleSelectDropdownEvents type
IStepBar type
IStepBarEvents type
IStepBarStep type
IStepBarStep1 type
IStepIndicator type
IStepIndicatorEvents type
IStepProgressBar type
ISwitchButton type
ISwitchButtonEvents type
ITabNavigationConfig type
ITabNavigationEvents type
ITabNavigationItem type
ITabNotification type
ITagStatus type
ITextField type
ITextField1 type
ITextFieldEvents type
ITimePicker type
ITimePickerEvents type
ITimePickerRelativeTime type
ITimePickerSelectOption type
ITimePickerSelectOptionEvents type
ITimePickerTime type
ITimePickerTimeState type
ITimePickerTimezone type
ITimePickerTimezone1 type
ITimezoneOffset type
ITimezoneOffset1 type
IToaster type
IToasterController type
IToasterEvents type
IToggleButton type
IToggleButtonEvents type
IToggleButtonGroup type
IToggleButtonGroupEvents type
IToggleSwitch type
IToggleSwitchEvents type
IToggleSwitchOption type
IToggleTip type
IToggleTipEvents type
ITooltip type
ITooltip1 type
ITooltipText type
ITypedDates type
IVirtualizedList type
IWizard type
IWizardEvents type
IWizardFooter type
IWizardFooterEvents type
IWizardHeader type
IWizardStep type
JSX type
KvAbsoluteTimePickerCustomEvent type
KvAbsoluteTimePickerDropdownCustomEvent type
KvAbsoluteTimePickerDropdownInputCustomEvent type
KvActionButtonCustomEvent type
KvActionButtonIconCustomEvent type
KvActionButtonMagicCustomEvent type
KvActionButtonSplitCustomEvent type
KvActionButtonTextCustomEvent type
KvActionMenu type An icon button that opens a menu of actions, with the menu button keyboard pattern: Enter, Space or ArrowDown open it on the first enabled action, the arrows, Home and End move between enabled actions, and Escape or Tab close it from the trigger. `kv-dropdown-base` moves the menu panel into a body portal, outside React's root, where React's delegated events never arrive. So the panel's listeners are native ones.
KvAlertCustomEvent type
KvBreadcrumbCustomEvent type
KvBreadcrumbItemCustomEvent type
KvBreadcrumbListCustomEvent type
KvCalendarCustomEvent type
KvCalendarDayCustomEvent type
KvCheckboxCustomEvent type
KvCodeDiffEditor type
KvCodeEditor type
KvDateTimeInputCustomEvent type
KvDropdownBaseCustomEvent type
KvDropdownCustomEvent type
KvInlineEditableFieldCustomEvent type
KvInputWrapperCustomEvent type
KvLinkCustomEvent type
KvModalCustomEvent type
KvMultiSelectDropdownCustomEvent type
KvPortalCustomEvent type
KvRadioCustomEvent type
KvRadioListCustomEvent type
KvRadioListItemCustomEvent type
KvRangeCustomEvent type
KvRelativeTimePickerCustomEvent type
KvSchemaForm type
KvSearchCustomEvent type
KvSelectCreateOptionCustomEvent type
KvSelectCustomEvent type
KvSelectMultiOptionsCustomEvent type
KvSelectOptionCustomEvent type
KvSingleSelectDropdownCustomEvent type
KvStepBarCustomEvent type
KvStepIndicatorCustomEvent type
KvSwitchButtonCustomEvent type
KvTabItemCustomEvent type
KvTabNavigationCustomEvent type
KvTextAreaCustomEvent type
KvTextFieldCustomEvent type
KvTimePickerCustomEvent type
KvTimePickerSelectOptionCustomEvent type
KvToasterCustomEvent type
KvToggleButtonCustomEvent type
KvToggleButtonGroupCustomEvent type
KvToggleSwitchCustomEvent type
KvToggleTipCustomEvent type
KvWizardCustomEvent type
KvWizardFooterCustomEvent type
MONACO_FONT_FAMILY type
MONACO_FONT_SIZE type
ModalOverlay type
ModalOverlayProps type
NormalizeEnumsResult type
OnCodeEditorChange type
RELATIVE_TIME_OFFSETS type Configuration mapping for all relative time range keys.
RelativeTimeOffsetConfig type Configuration for relative time offset calculations.
RenderItemFunc type
SchemaFormContext type
SchemaFormProps type
SelectedRange type
SelectedTime type
SelectedTimeState type
SelectedTimestamp type
SingleTime type
StepState type
StyleMode type
TIMEZONES type
TOGGLE_TIP_Z_INDEX value
TOOLTIP_Z_INDEX value
TimeRange type
TimeRangeCalendarKeys type Type for time range calendar keys.
TimestampRange type
ToasterContainer type
ToasterContainerProps type
UIComponentsConfig type
areDatesValid type
arraysHelper value
buildAbsoluteAmountOfUnitsConfigRange type
buildAllOptionsSelected type
buildDayjsRange type Builds the range of the start and end date and returns the range array, ordering the dates if needed
buildDefaultFormStateBehavior value
buildOptionRange type Date range builders
buildPartialOptionsSelected type
buildRelativeAmountOfUnitsConfigRange type
buildRelativeTimeOption type Builder function to create IRelativeTimePickerOption with automatic startDate/endDate derivation from RELATIVE_TIME_OFFSETS.
buildSelectedOptions type
buildSingleDateConfigRange type
buildStartDateEndDateConfigRange type
buildTimestampRange type
buildTimezoneByOffset type
calculateOffsetDate type
cleanUnsupportedSchemaKeys value
clipboardHelper value
copyTextToClipboard type
cssClassHelper value
dateHelper value
didClickOnElement type
fallbackCopyTextToClipboard type
flattenSelectOptionsArray type
floatingUIHelper value
formatDate type
formatDateTime type
formatForTimezone type
formatTimezoneName type
fromDateFields type
fromDateInput type
fromISO type
generateForm type
getAbsoluteTimeRange type Returns the provided range in utc.
getArrayOfIndexes type
getClassList type
getClassMap type
getDateMonth type
getDateYear type
getDatesBetweenRange type
getDefaultTimezone type
getDefaultTimezoneSettings type
getDefaultTimezones type The offset-sorted catalogue of every timezone the platform knows about, built at most once per page. `buildTimezoneByOffset(getTimezonesNames())` walks ~418 IANA zones and makes two `dayjs().tz(zone)` calls for each, so a single evaluation costs ~45ms of `Intl.DateTimeFormat` construction. Use this instead of calling the pair directly in a `@Prop` initialiser: those run per component instance, so a picker rendered once per row of a table made mounting (or unmounting) the table a multi-second blocking task. Offsets are resolved for "now", so a page left open across a DST transition keeps the offsets it started with. That was already true of any instance mounted before the transition, and one shared snapshot beats paying for a fresh one on every mount. Callers must treat the result as read-only — it is shared by every component that defaults to it.
getDefaultValidator value
getFirstWeekdayIndexOfMonth type
getFlattenSelectOptions type
getFlattenSelectOptionsArray type
getInitialFormData value
getMonthAndYearTitle type
getMonthName type
getNextEnabledIndex type Finds the enabled neighbor, wrapping and skipping disabled options. An unset origin starts at an end.
getNextHightlightableOption type
getNumberOfDaysInMonth type
getPreviousHightlightableOption type
getRelativeTimeCalculation type Derives DateTimeCalculation configuration from a relative time range key. This eliminates manual duplication of offset data.
getRelativeTimeOption type Finds a relative time option by its key from the provided options groups.
getRelativeTimeRangeISO type Returns a start and end time according to a relative time range in utc.
getRelativeTimeRangeName type
getRelativeTimeRangeTimestamp type Returns a start and end time according to a relative time range as timestamps.
getScrollBottom type
getScrollLeft type
getScrollRight type
getScrollTop type
getSelectableOptions type
getSelectableOptionsFromArray type
getSelectedCount type
getSelectedSelectableOptions type
getSlotElements type
getThemeMode type Gets the current theme mode.
getTimezoneOffset type
getTimezonesNames type
getUTF8StringLength type
getWeekdaysNames type
initialize value
isDateAfter type
isDateBefore type
isDateInArray type
isDateInRange type
isDateSame type
isDateTimeAfter type
isDateTimeBefore type
isDateValid type
isSubString type
isTargetOnElement type
isValidLabel type
mergeComputePositionConfigs type
mouseEventHelper value
newDate type Helper methods for date type display, parse, calculate and manipulation.
newTimezoneDate type
newTimezoneDateFromFormat type
normalizeEnums value Collapses simple `oneOf` constructs into an equivalent `{ enum: [...] }`, moving everything the branches carried into the uiSchema: titles to `ui:enumNames`, disabled options to `ui:enumDisabled` and per-option descriptions to `ui:enumDescriptions`. This is not cosmetic. AJV compiles `oneOf` as one nested `else` per branch, so an option list built from instance data — every asset, every data stream — produces a validator nested as deeply as the list, and `new Function` overflows the parser stack. `enum` compiles to a single loop instead. The protection reaches only option lists that sit at a static uiSchema path. A list inside a union branch, or behind a `$ref` into `definitions`, is left as a `oneOf` and can still reach AJV: the same definition may be referenced from several properties, and two union branches may name the same property, so there is no single path its titles could be written to. Collapsing those needs reference- and branch-aware traversal, which this does not attempt.
normalizeSchema value Normalizes a JSON schema by applying various transformations.
relativeTimeHelper value
searchDropdownOptions type
searchHelper value
searchString type
selectHelper value
setThemeMode type Dynamically sets the theme mode without requiring a page refresh. This updates the mode attribute on the body element, which triggers CSS custom properties to update across all components.
stringHelper value
toggleThemeMode type Toggles between light and dark theme modes.
useFontsApi type
useModal type
useSchemaFormFocusRef type Registers the editable control in a widget, including a custom native input or Kelvin host.
useScroll type
useToaster type
validateRelativeTimeOffsets type Validates that all keys in RELATIVE_TIME_OFFSETS are valid enum values. Useful for development/testing to ensure consistency.

React-authored component contracts

Defaults below come from source initializers or @default tags. Descriptive defaults also remain in the source comments. Inherited platform props are available in the installed declarations. Source and usage links refer to the repository dev branch; use the installed declarations for the shipped version.

Component

Import: @kelvininc/react-ui-components/client. Source.

Signature: ({ forwardedRef, instanceRef, originalCode, modifiedCode, language, theme, customTheme, customOptions, LoadingComponent, onChange }: ICodeDiffEditorProps): Element.

Prop Required Type Call signatures Declared default Description
LoadingComponent no FunctionComponent<{}> | undefined (props: {}): ReactNode | Promise<ReactNode> CodeEditorLoader Use this property to define a placeholder component to display when the editor is loading.
customOptions no CodeDiffEditorOptions | undefined not declared Use this property to define options on the editor
customTheme no IStandaloneThemeData | undefined not declared Use this property to define and set a custom theme on the editor
forwardedRef no ForwardedRef<IStandaloneCodeEditor> | undefined not declared Use this property to pass a ref to the editor.
instanceRef no ForwardedRef<typeof import("monaco-editor/esm/vs/editor/editor.api")> | undefined not declared Use this property to pass a ref to the editor instance.
language no string | undefined DEFAULT_CODE_EDITOR_LANGUAGE Use this property to define the language mode of the editor.
modifiedCode no string | undefined not declared Use this property to pass the modified code value to the editor.
onChange no OnCodeEditorChange | undefined (value: string | undefined): void not declared Use this property to pass a callback function for when the value (`code`) changes.
originalCode no string | undefined not declared Use this property to pass the original code value to the editor.
theme no ECodeEditorTheme | undefined ECodeEditorTheme.Dark Use this property to define the theme of the editor.

CustomForm

Import: @kelvininc/react-ui-components/client. Source · Usage.

Signature: <T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>({ children, ...otherProps }: PropsWithChildren<FormProps<T, S, F>>, ref?: ForwardedRef<Form<T, S, F>> | undefined): Element.

Prop Required Type Call signatures Declared default Description
_internalFormWrapper no ElementType | undefined not declared _internalFormWrapper is currently used by the semantic-ui theme to provide a custom wrapper around `` that supports the proper rendering of those themes. To use this prop, one must pass a component that takes two props: `children` and `as`. That component, at minimum, should render the `children` inside of a tag unless `as` is provided, in which case, use the `as` prop in place of ``. i.e.: ``` export default function InternalForm({ children, as }) { const FormTag = as || 'form'; return {children}; } ``` Use at your own risk as this prop is private and may change at any time without notice.
acceptCharset no string | undefined not declared The value of this prop will be passed to the `accept-charset` HTML attribute on the form
acceptcharset no string | undefined not declared The value of this prop will be passed to the `accept-charset` HTML attribute on the form
action no string | undefined not declared The value of this prop will be passed to the `action` HTML attribute on the form NOTE: this just renders the `action` attribute in the HTML markup. There is no real network request being sent to this `action` on submit. Instead, react-jsonschema-form catches the submit event with `event.preventDefault()` and then calls the `onSubmit` function, where you could send a request programmatically with `fetch` or similar.
autoComplete no string | undefined not declared The value of this prop will be passed to the `autocomplete` HTML attribute on the form
children no ReactNode not declared The optional children for the form, if provided, it will replace the default `SubmitButton`
className no string | undefined not declared The value of this prop will be passed to the `class` HTML attribute on the form
customValidate no CustomValidator<T, S, F> | undefined (formData: T | undefined, errors: FormValidation<T>, uiSchema?: UiSchema<T, S, F> | undefined): FormValidation<T> not declared Formerly the `validate` prop; Takes a function that specifies custom validation rules for the form
disabled no boolean | undefined not declared It's possible to disable the whole form by setting the `disabled` prop. The `disabled` prop is then forwarded down to each field of the form. If you just want to disable some fields, see the `ui:disabled` parameter in `uiSchema`
enctype no string | undefined not declared The value of this prop will be passed to the `enctype` HTML attribute on the form
experimental_customMergeAllOf no Experimental_CustomMergeAllOf<S> | undefined (schema: S): S not declared Optional function that allows for custom merging of `allOf` schemas
experimental_defaultFormStateBehavior no Experimental_DefaultFormStateBehavior | undefined not declared Optional configuration object with flags, if provided, allows users to override default form state behavior Currently only affecting minItems on array fields and handling of setting defaults based on the value of `emptyObjectFields`
extraErrors no ErrorSchema<T> | undefined not declared This prop allows passing in custom errors that are augmented with the existing JSON Schema errors on the form; it can be used to implement asynchronous validation. By default, these are non-blocking errors, meaning that you can still submit the form when these are the only errors displayed to the user.
extraErrorsBlockSubmit no boolean | undefined not declared If set to true, causes the `extraErrors` to become blocking when the form is submitted
fields no RegistryFieldsType<T, S, F> | undefined not declared The dictionary of registered fields in the form
focusOnFirstError no boolean | ((error: RJSFValidationError) => void) | undefined not declared If set to true, then the first field with an error will receive the focus when the form is submitted with errors
formContext no F | undefined not declared You can provide a `formContext` object to the form, which is passed down to all fields and widgets. Useful for implementing context aware fields and widgets. NOTE: Setting `{readonlyAsDisabled: false}` on the formContext will make the antd theme treat readOnly fields as disabled.
formData no T | undefined not declared The data for the form, used to prefill a form with existing data
id no string | undefined not declared The value of this prop will be passed to the `id` HTML attribute on the form
idPrefix no string | undefined not declared To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids; Default is `root`
idSeparator no string | undefined not declared To avoid using a path separator that is present in field names, it is possible to change the separator used for ids (Default is `_`)
liveOmit no boolean | undefined not declared If `omitExtraData` and `liveOmit` are both set to true, then extra form data values that are not in any form field will be removed whenever `onChange` is called. Set to `false` by default
liveValidate no boolean | undefined not declared If set to true, the form will perform validation and show any validation errors whenever the form data is changed, rather than just on submit
method no string | undefined not declared The value of this prop will be passed to the `method` HTML attribute on the form
name no string | undefined not declared The value of this prop will be passed to the `name` HTML attribute on the form
noHtml5Validate no boolean | undefined not declared If set to true, turns off HTML5 validation on the form; Set to `false` by default
noValidate no boolean | undefined not declared If set to true, turns off all validation. Set to `false` by default
omitExtraData no boolean | undefined not declared If set to true, then extra form data values that are not in any form field will be removed whenever `onSubmit` is called. Set to `false` by default.
onBlur no ((id: string, data: any) => void) | undefined (id: string, data: any): void not declared Sometimes you may want to trigger events or modify external state when a field has been touched, so you can pass an `onBlur` handler, which will receive the id of the input that was blurred and the field value
onChange no ((data: IChangeEvent<T, S, F>, id?: string | undefined) => void) | undefined (data: IChangeEvent<T, S, F>, id?: string | undefined): void not declared If you plan on being notified every time the form data are updated, you can pass an `onChange` handler, which will receive the same args as `onSubmit` any time a value is updated in the form. Can also return the `id` of the field that caused the change
onError no ((errors: RJSFValidationError[]) => void) | undefined (errors: RJSFValidationError[]): void not declared To react when submitted form data are invalid, pass an `onError` handler. It will be passed the list of encountered errors
onFocus no ((id: string, data: any) => void) | undefined (id: string, data: any): void not declared Sometimes you may want to trigger events or modify external state when a field has been focused, so you can pass an `onFocus` handler, which will receive the id of the input that is focused and the field value
onSubmit no ((data: IChangeEvent<T, S, F>, event: FormEvent<any>) => void) | undefined (data: IChangeEvent<T, S, F>, event: FormEvent<any>): void not declared You can pass a function as the `onSubmit` prop of your `Form` component to listen to when the form is submitted and its data are valid. It will be passed a result object having a `formData` attribute, which is the valid form data you're usually after. The original event will also be passed as a second parameter
readonly no boolean | undefined not declared It's possible to make the whole form read-only by setting the `readonly` prop. The `readonly` prop is then forwarded down to each field of the form. If you just want to make some fields read-only, see the `ui:readonly` parameter in `uiSchema`
ref no Ref<Form<T, S, F>> | undefined not declared Support receiving a React ref to the Form
schema yes S not declared The JSON schema object for the form
showErrorList no false | "top" | "bottom" | undefined not declared When this prop is set to `top` or 'bottom', a list of errors (or the custom error list defined in the `ErrorList`) will also show. When set to false, only inline input validation errors will be shown. Set to `top` by default
tagName no ElementType | undefined not declared It's possible to change the default `form` tag name to a different HTML tag, which can be helpful if you are nesting forms. However, native browser form behaviour, such as submitting when the `Enter` key is pressed, may no longer work
target no string | undefined not declared The value of this prop will be passed to the `target` HTML attribute on the form
templates no (Partial<Omit<TemplatesType<T, S, F>, "ButtonTemplates">> & { ButtonTemplates?: Partial<{ SubmitButton: ComponentType<SubmitButtonProps<T, S, F>>; AddButton: ComponentType<IconButtonProps<T, S, F>>; CopyButton: ComponentType<IconButtonProps<T, S, F>>; MoveDownButton: ComponentType<IconButtonProps<T, S, F>>; MoveUpButton: ComponentType<IconButtonProps<T, S, F>>; RemoveButton: ComponentType<IconButtonProps<T, S, F>>; }> | undefined; }) | undefined not declared The dictionary of registered templates in the form; Partial allows a subset to be provided beyond the defaults
transformErrors no ErrorTransformer<T, S, F> | undefined (errors: RJSFValidationError[], uiSchema?: UiSchema<T, S, F> | undefined): RJSFValidationError[] not declared A function can be passed to this prop in order to make modifications to the default errors resulting from JSON Schema validation
translateString no ((stringKey: TranslatableString, params?: string[] | undefined) => string) | undefined (stringKey: TranslatableString, params?: string[] | undefined): string not declared Optional string translation function, if provided, allows users to change the translation of the RJSF internal strings. Some strings contain replaceable parameter values as indicated by `%1`, `%2`, etc. The number after the `%` indicates the order of the parameter. The ordering of parameters is important because some languages may choose to put the second parameter before the first in its translation.
uiSchema no UiSchema<T, S, F> | undefined not declared The uiSchema for the form
validator yes ValidatorType<T, S, F> not declared An implementation of the `ValidatorType` interface that is needed for form validation to work
widgets no RegistryWidgetsType<T, S, F> | undefined not declared The dictionary of registered widgets in the form

KvActionMenu

Import: @kelvininc/react-ui-components/client. Source · Usage.

An icon button that opens a menu of actions, with the menu button keyboard pattern: Enter, Space or ArrowDown open it on the first enabled action, the arrows, Home and End move between enabled actions, and Escape or Tab close it from the trigger.

kv-dropdown-base moves the menu panel into a body portal, outside React's root, where React's delegated events never arrive. So the panel's listeners are native ones.

Signature: (props: IActionMenuProps & RefAttributes<IActionMenuHandle>): ReactNode.

Prop Required Type Call signatures Declared default Description
accessibleLabel yes string not declared (required) Nonblank accessible name for the trigger and its menu
className no string | undefined not declared (optional) Class added to the element that wraps the trigger
disabled no boolean | undefined false (optional) Disables the trigger and closes its menu
icon no EIconName | undefined DEFAULT_ACTION_MENU_ICON (optional) Trigger icon. Defaults to More
items no readonly IActionMenuItem[] | undefined NO_ACTIONS (optional) Actions in display order, with unique ids
onItemSelected no ((id: string) => void) | undefined (id: string): void not declared Called once with the selected action's id, after closing and returning focus to the trigger
size no EComponentSize | undefined EComponentSize.Small (optional) Trigger size. Defaults to Small
triggerTabIndex no number | undefined not declared (optional) Trigger Tab index. Use -1 to exclude it from sequential focus while keeping `setFocus()`
zIndex no number | undefined DEFAULT_DROPDOWN_Z_INDEX (optional) Menu panel z-index. Defaults to DEFAULT_DROPDOWN_Z_INDEX

Ref handle: IActionMenuHandle.

Members declared by dependencies are documented in their installed TypeScript declarations.

Member Required Type Call signatures Declared default Description
setFocus yes (canFocus?: (() => boolean) | undefined) => Promise<boolean> (canFocus?: (() => boolean) | undefined): Promise<boolean> not declared Waits for the trigger to be ready, then focuses it without opening the menu. Resolves `true` when the trigger has focus.

KvCodeDiffEditor

Import: @kelvininc/react-ui-components/client. Source.

Signature: (props: ICodeDiffEditorProps & RefAttributes<IStandaloneCodeEditor>): ReactNode.

Prop Required Type Call signatures Declared default Description
LoadingComponent no FunctionComponent<{}> | undefined (props: {}): ReactNode | Promise<ReactNode> CodeEditorLoader Use this property to define a placeholder component to display when the editor is loading.
customOptions no CodeDiffEditorOptions | undefined not declared Use this property to define options on the editor
customTheme no IStandaloneThemeData | undefined not declared Use this property to define and set a custom theme on the editor
forwardedRef no ForwardedRef<IStandaloneCodeEditor> | undefined not declared Use this property to pass a ref to the editor.
instanceRef no ForwardedRef<typeof import("monaco-editor/esm/vs/editor/editor.api")> | undefined not declared Use this property to pass a ref to the editor instance.
language no string | undefined DEFAULT_CODE_EDITOR_LANGUAGE Use this property to define the language mode of the editor.
modifiedCode no string | undefined not declared Use this property to pass the modified code value to the editor.
onChange no OnCodeEditorChange | undefined (value: string | undefined): void not declared Use this property to pass a callback function for when the value (`code`) changes.
originalCode no string | undefined not declared Use this property to pass the original code value to the editor.
theme no ECodeEditorTheme | undefined ECodeEditorTheme.Dark Use this property to define the theme of the editor.

Ref handle: IStandaloneCodeEditor.

Members declared by dependencies are documented in their installed TypeScript declarations.

Member Required Type Call signatures Declared default Description
updateOptions yes (newOptions: IEditorOptions & IGlobalEditorOptions) => void (newOptions: IEditorOptions & IGlobalEditorOptions): void not declared Update the editor's options after the editor has been created.
addCommand yes (keybinding: number, handler: ICommandHandler, context?: string | undefined) => string | null (keybinding: number, handler: ICommandHandler, context?: string | undefined): string | null not declared
createContextKey yes <T extends ContextKeyValue = ContextKeyValue>(key: string, defaultValue: T) => IContextKey<T> <T extends ContextKeyValue = ContextKeyValue>(key: string, defaultValue: T): IContextKey<T> not declared
addAction yes (descriptor: IActionDescriptor) => IDisposable (descriptor: IActionDescriptor): IDisposable not declared
onDidChangeModelContent yes IEvent<IModelContentChangedEvent> (listener: (e: IModelContentChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the content of the current model has changed.
onDidChangeModelLanguage yes IEvent<IModelLanguageChangedEvent> (listener: (e: IModelLanguageChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the language of the current model has changed.
onDidChangeModelLanguageConfiguration yes IEvent<IModelLanguageConfigurationChangedEvent> (listener: (e: IModelLanguageConfigurationChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the language configuration of the current model has changed.
onDidChangeModelOptions yes IEvent<IModelOptionsChangedEvent> (listener: (e: IModelOptionsChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the options of the current model has changed.
onDidChangeConfiguration yes IEvent<ConfigurationChangedEvent> (listener: (e: ConfigurationChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
onDidChangeCursorPosition yes IEvent<ICursorPositionChangedEvent> (listener: (e: ICursorPositionChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the cursor position has changed.
onDidChangeCursorSelection yes IEvent<ICursorSelectionChangedEvent> (listener: (e: ICursorSelectionChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the cursor selection has changed.
onDidChangeModel yes IEvent<IModelChangedEvent> (listener: (e: IModelChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
onDidChangeModelDecorations yes IEvent<IModelDecorationsChangedEvent> (listener: (e: IModelDecorationsChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the decorations of the current model have changed.
onDidFocusEditorText yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
onDidBlurEditorText yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
onDidFocusEditorWidget yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor or an editor widget gained focus.
onDidBlurEditorWidget yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor or an editor widget lost focus.
onDidCompositionStart yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted after composition has started.
onDidCompositionEnd yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted after composition has ended.
onDidAttemptReadOnlyEdit yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when editing failed because the editor is read-only.
onDidPaste yes IEvent<IPasteEvent> (listener: (e: IPasteEvent) => any, thisArg?: any): IDisposable not declared An event emitted when users paste text in the editor.
onMouseUp yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mouseup".
onMouseDown yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mousedown".
onContextMenu yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "contextmenu".
onMouseMove yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mousemove".
onMouseLeave yes IEvent<IPartialEditorMouseEvent> (listener: (e: IPartialEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mouseleave".
onKeyUp yes IEvent<IKeyboardEvent> (listener: (e: IKeyboardEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "keyup".
onKeyDown yes IEvent<IKeyboardEvent> (listener: (e: IKeyboardEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "keydown".
onDidLayoutChange yes IEvent<EditorLayoutInfo> (listener: (e: EditorLayoutInfo) => any, thisArg?: any): IDisposable not declared An event emitted when the layout of the editor has changed.
onDidContentSizeChange yes IEvent<IContentSizeChangedEvent> (listener: (e: IContentSizeChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the content width or content height in the editor has changed.
onDidScrollChange yes IEvent<IScrollEvent> (listener: (e: IScrollEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the scroll in the editor has changed.
onDidChangeHiddenAreas yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when hidden areas change in the editor (e.g. due to folding).
saveViewState yes () => ICodeEditorViewState | null (): ICodeEditorViewState | null not declared Saves current view state of the editor in a serializable object.
restoreViewState yes (state: ICodeEditorViewState | null) => void (state: ICodeEditorViewState | null): void not declared Restores the view state of the editor from a serializable object generated by `saveViewState`.
hasWidgetFocus yes () => boolean (): boolean not declared Returns true if the text inside this editor or an editor widget has focus.
getContribution yes <T extends IEditorContribution>(id: string) => T | null <T extends IEditorContribution>(id: string): T | null not declared Get a contribution of this editor.
getModel yes () => ITextModel | null (): ITextModel | null not declared Type the getModel() of IEditor.
setModel yes (model: ITextModel | null) => void (model: ITextModel | null): void not declared Sets the current model attached to this editor. If the previous model was created by the editor via the value key in the options literal object, it will be destroyed. Otherwise, if the previous model was set via setModel, or the model key in the options literal object, the previous model will not be destroyed. It is safe to call setModel(null) to simply detach the current model from the editor.
getOptions yes () => IComputedEditorOptions (): IComputedEditorOptions not declared Gets all the editor computed options.
getOption yes <T extends EditorOption>(id: T) => FindComputedEditorOptionValueById<T> <T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T> not declared Gets a specific editor option.
getRawOptions yes () => IEditorOptions (): IEditorOptions not declared Returns the editor's configuration (without any validation or defaults).
getValue yes (options?: { preserveBOM: boolean; lineEnding: string; } | undefined) => string (options?: { preserveBOM: boolean; lineEnding: string; } | undefined): string not declared Get value of the current model attached to this editor.
setValue yes (newValue: string) => void (newValue: string): void not declared Set the value of the current model attached to this editor.
getContentWidth yes () => number (): number not declared Get the width of the editor's content. This is information that is "erased" when computing `scrollWidth = Math.max(contentWidth, width)`
getScrollWidth yes () => number (): number not declared Get the scrollWidth of the editor's viewport.
getScrollLeft yes () => number (): number not declared Get the scrollLeft of the editor's viewport.
getContentHeight yes () => number (): number not declared Get the height of the editor's content. This is information that is "erased" when computing `scrollHeight = Math.max(contentHeight, height)`
getScrollHeight yes () => number (): number not declared Get the scrollHeight of the editor's viewport.
getScrollTop yes () => number (): number not declared Get the scrollTop of the editor's viewport.
setScrollLeft yes (newScrollLeft: number, scrollType?: ScrollType | undefined) => void (newScrollLeft: number, scrollType?: ScrollType | undefined): void not declared Change the scrollLeft of the editor's viewport.
setScrollTop yes (newScrollTop: number, scrollType?: ScrollType | undefined) => void (newScrollTop: number, scrollType?: ScrollType | undefined): void not declared Change the scrollTop of the editor's viewport.
setScrollPosition yes (position: INewScrollPosition, scrollType?: ScrollType | undefined) => void (position: INewScrollPosition, scrollType?: ScrollType | undefined): void not declared Change the scroll position of the editor's viewport.
getAction yes (id: string) => IEditorAction (id: string): IEditorAction not declared Get an action that is a contribution to this editor.
executeCommand yes (source: string | null | undefined, command: ICommand) => void (source: string | null | undefined, command: ICommand): void not declared Execute a command on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
pushUndoStop yes () => boolean (): boolean not declared Create an "undo stop" in the undo-redo stack.
popUndoStop yes () => boolean (): boolean not declared Remove the "undo stop" in the undo-redo stack.
executeEdits yes (source: string | null | undefined, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[] | undefined) => boolean (source: string | null | undefined, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[] | undefined): boolean not declared Execute edits on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
executeCommands yes (source: string | null | undefined, commands: (ICommand | null)[]) => void (source: string | null | undefined, commands: (ICommand | null)[]): void not declared Execute multiple (concomitant) commands on the editor.
getLineDecorations yes (lineNumber: number) => IModelDecoration[] | null (lineNumber: number): IModelDecoration[] | null not declared Get all the decorations on a line (filtering out decorations from other editors).
getDecorationsInRange yes (range: Range) => IModelDecoration[] | null (range: Range): IModelDecoration[] | null not declared Get all the decorations for a range (filtering out decorations from other editors).
deltaDecorations yes (oldDecorations: string[], newDecorations: IModelDeltaDecoration[]) => string[] (oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] not declared All decorations added through this call will get the ownerId of this editor.
removeDecorations yes (decorationIds: string[]) => void (decorationIds: string[]): void not declared Remove previously added decorations.
getLayoutInfo yes () => EditorLayoutInfo (): EditorLayoutInfo not declared Get the layout info for the editor.
getVisibleRanges yes () => Range[] (): Range[] not declared Returns the ranges that are currently visible. Does not account for horizontal scrolling.
getTopForLineNumber yes (lineNumber: number) => number (lineNumber: number): number not declared Get the vertical position (top offset) for the line's top w.r.t. to the first line.
getBottomForLineNumber yes (lineNumber: number) => number (lineNumber: number): number not declared Get the vertical position (top offset) for the line's bottom w.r.t. to the first line.
getTopForPosition yes (lineNumber: number, column: number) => number (lineNumber: number, column: number): number not declared Get the vertical position (top offset) for the position w.r.t. to the first line.
getContainerDomNode yes () => HTMLElement (): HTMLElement not declared Returns the editor's container dom node
getDomNode yes () => HTMLElement | null (): HTMLElement | null not declared Returns the editor's dom node
addContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.
layoutContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
removeContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Remove a content widget.
addOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.
layoutOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
removeOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Remove an overlay widget.
changeViewZones yes (callback: (accessor: IViewZoneChangeAccessor) => void) => void (callback: (accessor: IViewZoneChangeAccessor) => void): void not declared Change the view zones. View zones are lost when a new model is attached to the editor.
getOffsetForColumn yes (lineNumber: number, column: number) => number (lineNumber: number, column: number): number not declared Get the horizontal position (left offset) for the column w.r.t to the beginning of the line. This method works only if the line `lineNumber` is currently rendered (in the editor's viewport). Use this method with caution.
render yes (forceRedraw?: boolean | undefined) => void (forceRedraw?: boolean | undefined): void not declared Force an editor render now.
getTargetAtClientPoint yes (clientX: number, clientY: number) => IMouseTarget | null (clientX: number, clientY: number): IMouseTarget | null not declared Get the hit test target at coordinates `clientX` and `clientY`. The coordinates are relative to the top-left of the viewport.
getScrolledVisiblePosition yes (position: IPosition) => { top: number; left: number; height: number; } | null (position: IPosition): { top: number; left: number; height: number; } | null not declared Get the visible position for `position`. The result position takes scrolling into account and is relative to the top left corner of the editor. Explanation 1: the results of this method will change for the same `position` if the user scrolls the editor. Explanation 2: the results of this method will not change if the container of the editor gets repositioned. Warning: the results of this method are inaccurate for positions that are outside the current editor viewport.
applyFontInfo yes (target: HTMLElement) => void (target: HTMLElement): void not declared Apply the same font settings as the editor to `target`.
setBanner yes (bannerDomNode: HTMLElement | null, height: number) => void (bannerDomNode: HTMLElement | null, height: number): void not declared
onDidDispose yes (listener: () => void) => IDisposable (listener: () => void): IDisposable not declared An event emitted when the editor has been disposed.
dispose yes () => void (): void not declared Dispose the editor.
getId yes () => string (): string not declared Get a unique id for this editor instance.
getEditorType yes () => string (): string not declared Get the editor type. Please see `EditorType`. This is to avoid an instanceof check
layout yes (dimension?: IDimension | undefined) => void (dimension?: IDimension | undefined): void not declared Instructs the editor to remeasure its container. This method should be called when the container of the editor gets resized. If a dimension is passed in, the passed in value will be used.
focus yes () => void (): void not declared Brings browser focus to the editor text
hasTextFocus yes () => boolean (): boolean not declared Returns true if the text inside this editor is focused (i.e. cursor is blinking).
getSupportedActions yes () => IEditorAction[] (): IEditorAction[] not declared Returns all actions associated with this editor.
getVisibleColumnFromPosition yes (position: IPosition) => number (position: IPosition): number not declared Given a position, returns a column number that takes tab-widths into account.
getPosition yes () => Position | null (): Position | null not declared Returns the primary position of the cursor.
setPosition yes (position: IPosition, source?: string | undefined) => void (position: IPosition, source?: string | undefined): void not declared Set the primary position of the cursor. This will remove any secondary cursors.
revealLine yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line.
revealLineInCenter yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line centered vertically.
revealLineInCenterIfOutsideViewport yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
revealLineNearTop yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition.
revealPosition yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position.
revealPositionInCenter yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position centered vertically.
revealPositionInCenterIfOutsideViewport yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.
revealPositionNearTop yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position close to the top of the viewport, optimized for viewing a code definition.
getSelection yes () => Selection | null (): Selection | null not declared Returns the primary selection of the editor.
getSelections yes () => Selection[] | null (): Selection[] | null not declared Returns all the selections of the editor.
setSelection yes { (selection: IRange, source?: string | undefined): void; (selection: Range, source?: string | undefined): void; (selection: ISelection, source?: string | undefined): void; (selection: Selection, source?: string | undefined): void; } (selection: IRange, source?: string | undefined): void; (selection: Range, source?: string | undefined): void; (selection: ISelection, source?: string | undefined): void; (selection: Selection, source?: string | undefined): void not declared Set the primary selection of the editor. This will remove any secondary cursors.
setSelections yes (selections: readonly ISelection[], source?: string | undefined) => void (selections: readonly ISelection[], source?: string | undefined): void not declared Set the selections for all the cursors of the editor. Cursors will be removed or added, as necessary.
revealLines yes (startLineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (startLineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines.
revealLinesInCenter yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines centered vertically.
revealLinesInCenterIfOutsideViewport yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.
revealLinesNearTop yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines close to the top of the viewport, optimized for viewing a code definition.
revealRange yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range.
revealRangeInCenter yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range centered vertically.
revealRangeAtTop yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.
revealRangeInCenterIfOutsideViewport yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.
revealRangeNearTop yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition.
revealRangeNearTopIfOutsideViewport yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition. Only if it lies outside the viewport.
trigger yes (source: string | null | undefined, handlerId: string, payload: any) => void (source: string | null | undefined, handlerId: string, payload: any): void not declared Directly trigger a handler or an editor action.
createDecorationsCollection yes (decorations?: IModelDeltaDecoration[] | undefined) => IEditorDecorationsCollection (decorations?: IModelDeltaDecoration[] | undefined): IEditorDecorationsCollection not declared Create a collection of decorations. All decorations added through this collection will get the ownerId of the editor (meaning they will not show up in other editors). These decorations will be automatically cleared when the editor's model changes.

KvCodeEditor

Import: @kelvininc/react-ui-components/client. Source.

Signature: (props: ICodeEditorProps & RefAttributes<IStandaloneCodeEditor>): ReactNode.

Prop Required Type Call signatures Declared default Description
LoadingComponent no FunctionComponent<{}> | undefined (props: {}): ReactNode | Promise<ReactNode> CodeEditorLoader Use this property to define a placeholder component to display when the editor is loading.
code no string | undefined not declared Use this property to pass a starting value to the editor.
customOptions no CodeEditorOptions | undefined not declared Use this property to define options on the editor
customTheme no IStandaloneThemeData | undefined not declared Use this property to define and set a custom theme on the editor
forwardedRef no ForwardedRef<IStandaloneCodeEditor> | undefined not declared Use this property to pass a ref to the editor.
instanceRef no ForwardedRef<typeof import("monaco-editor/esm/vs/editor/editor.api")> | undefined not declared Use this property to pass a ref to the editor instance.
language no string | undefined DEFAULT_CODE_EDITOR_LANGUAGE Use this property to define the language mode of the editor.
onChange no OnCodeEditorChange | undefined (value: string | undefined): void not declared Use this property to pass a callback function for when the value (`code`) changes.
theme no ECodeEditorTheme | undefined ECodeEditorTheme.Dark Use this property to define the theme of the editor.

Ref handle: IStandaloneCodeEditor.

Members declared by dependencies are documented in their installed TypeScript declarations.

Member Required Type Call signatures Declared default Description
updateOptions yes (newOptions: IEditorOptions & IGlobalEditorOptions) => void (newOptions: IEditorOptions & IGlobalEditorOptions): void not declared Update the editor's options after the editor has been created.
addCommand yes (keybinding: number, handler: ICommandHandler, context?: string | undefined) => string | null (keybinding: number, handler: ICommandHandler, context?: string | undefined): string | null not declared
createContextKey yes <T extends ContextKeyValue = ContextKeyValue>(key: string, defaultValue: T) => IContextKey<T> <T extends ContextKeyValue = ContextKeyValue>(key: string, defaultValue: T): IContextKey<T> not declared
addAction yes (descriptor: IActionDescriptor) => IDisposable (descriptor: IActionDescriptor): IDisposable not declared
onDidChangeModelContent yes IEvent<IModelContentChangedEvent> (listener: (e: IModelContentChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the content of the current model has changed.
onDidChangeModelLanguage yes IEvent<IModelLanguageChangedEvent> (listener: (e: IModelLanguageChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the language of the current model has changed.
onDidChangeModelLanguageConfiguration yes IEvent<IModelLanguageConfigurationChangedEvent> (listener: (e: IModelLanguageConfigurationChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the language configuration of the current model has changed.
onDidChangeModelOptions yes IEvent<IModelOptionsChangedEvent> (listener: (e: IModelOptionsChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the options of the current model has changed.
onDidChangeConfiguration yes IEvent<ConfigurationChangedEvent> (listener: (e: ConfigurationChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
onDidChangeCursorPosition yes IEvent<ICursorPositionChangedEvent> (listener: (e: ICursorPositionChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the cursor position has changed.
onDidChangeCursorSelection yes IEvent<ICursorSelectionChangedEvent> (listener: (e: ICursorSelectionChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the cursor selection has changed.
onDidChangeModel yes IEvent<IModelChangedEvent> (listener: (e: IModelChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
onDidChangeModelDecorations yes IEvent<IModelDecorationsChangedEvent> (listener: (e: IModelDecorationsChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the decorations of the current model have changed.
onDidFocusEditorText yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
onDidBlurEditorText yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
onDidFocusEditorWidget yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor or an editor widget gained focus.
onDidBlurEditorWidget yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when the text inside this editor or an editor widget lost focus.
onDidCompositionStart yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted after composition has started.
onDidCompositionEnd yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted after composition has ended.
onDidAttemptReadOnlyEdit yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when editing failed because the editor is read-only.
onDidPaste yes IEvent<IPasteEvent> (listener: (e: IPasteEvent) => any, thisArg?: any): IDisposable not declared An event emitted when users paste text in the editor.
onMouseUp yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mouseup".
onMouseDown yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mousedown".
onContextMenu yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "contextmenu".
onMouseMove yes IEvent<IEditorMouseEvent> (listener: (e: IEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mousemove".
onMouseLeave yes IEvent<IPartialEditorMouseEvent> (listener: (e: IPartialEditorMouseEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "mouseleave".
onKeyUp yes IEvent<IKeyboardEvent> (listener: (e: IKeyboardEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "keyup".
onKeyDown yes IEvent<IKeyboardEvent> (listener: (e: IKeyboardEvent) => any, thisArg?: any): IDisposable not declared An event emitted on a "keydown".
onDidLayoutChange yes IEvent<EditorLayoutInfo> (listener: (e: EditorLayoutInfo) => any, thisArg?: any): IDisposable not declared An event emitted when the layout of the editor has changed.
onDidContentSizeChange yes IEvent<IContentSizeChangedEvent> (listener: (e: IContentSizeChangedEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the content width or content height in the editor has changed.
onDidScrollChange yes IEvent<IScrollEvent> (listener: (e: IScrollEvent) => any, thisArg?: any): IDisposable not declared An event emitted when the scroll in the editor has changed.
onDidChangeHiddenAreas yes IEvent<void> (listener: (e: void) => any, thisArg?: any): IDisposable not declared An event emitted when hidden areas change in the editor (e.g. due to folding).
saveViewState yes () => ICodeEditorViewState | null (): ICodeEditorViewState | null not declared Saves current view state of the editor in a serializable object.
restoreViewState yes (state: ICodeEditorViewState | null) => void (state: ICodeEditorViewState | null): void not declared Restores the view state of the editor from a serializable object generated by `saveViewState`.
hasWidgetFocus yes () => boolean (): boolean not declared Returns true if the text inside this editor or an editor widget has focus.
getContribution yes <T extends IEditorContribution>(id: string) => T | null <T extends IEditorContribution>(id: string): T | null not declared Get a contribution of this editor.
getModel yes () => ITextModel | null (): ITextModel | null not declared Type the getModel() of IEditor.
setModel yes (model: ITextModel | null) => void (model: ITextModel | null): void not declared Sets the current model attached to this editor. If the previous model was created by the editor via the value key in the options literal object, it will be destroyed. Otherwise, if the previous model was set via setModel, or the model key in the options literal object, the previous model will not be destroyed. It is safe to call setModel(null) to simply detach the current model from the editor.
getOptions yes () => IComputedEditorOptions (): IComputedEditorOptions not declared Gets all the editor computed options.
getOption yes <T extends EditorOption>(id: T) => FindComputedEditorOptionValueById<T> <T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T> not declared Gets a specific editor option.
getRawOptions yes () => IEditorOptions (): IEditorOptions not declared Returns the editor's configuration (without any validation or defaults).
getValue yes (options?: { preserveBOM: boolean; lineEnding: string; } | undefined) => string (options?: { preserveBOM: boolean; lineEnding: string; } | undefined): string not declared Get value of the current model attached to this editor.
setValue yes (newValue: string) => void (newValue: string): void not declared Set the value of the current model attached to this editor.
getContentWidth yes () => number (): number not declared Get the width of the editor's content. This is information that is "erased" when computing `scrollWidth = Math.max(contentWidth, width)`
getScrollWidth yes () => number (): number not declared Get the scrollWidth of the editor's viewport.
getScrollLeft yes () => number (): number not declared Get the scrollLeft of the editor's viewport.
getContentHeight yes () => number (): number not declared Get the height of the editor's content. This is information that is "erased" when computing `scrollHeight = Math.max(contentHeight, height)`
getScrollHeight yes () => number (): number not declared Get the scrollHeight of the editor's viewport.
getScrollTop yes () => number (): number not declared Get the scrollTop of the editor's viewport.
setScrollLeft yes (newScrollLeft: number, scrollType?: ScrollType | undefined) => void (newScrollLeft: number, scrollType?: ScrollType | undefined): void not declared Change the scrollLeft of the editor's viewport.
setScrollTop yes (newScrollTop: number, scrollType?: ScrollType | undefined) => void (newScrollTop: number, scrollType?: ScrollType | undefined): void not declared Change the scrollTop of the editor's viewport.
setScrollPosition yes (position: INewScrollPosition, scrollType?: ScrollType | undefined) => void (position: INewScrollPosition, scrollType?: ScrollType | undefined): void not declared Change the scroll position of the editor's viewport.
getAction yes (id: string) => IEditorAction (id: string): IEditorAction not declared Get an action that is a contribution to this editor.
executeCommand yes (source: string | null | undefined, command: ICommand) => void (source: string | null | undefined, command: ICommand): void not declared Execute a command on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
pushUndoStop yes () => boolean (): boolean not declared Create an "undo stop" in the undo-redo stack.
popUndoStop yes () => boolean (): boolean not declared Remove the "undo stop" in the undo-redo stack.
executeEdits yes (source: string | null | undefined, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[] | undefined) => boolean (source: string | null | undefined, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[] | undefined): boolean not declared Execute edits on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
executeCommands yes (source: string | null | undefined, commands: (ICommand | null)[]) => void (source: string | null | undefined, commands: (ICommand | null)[]): void not declared Execute multiple (concomitant) commands on the editor.
getLineDecorations yes (lineNumber: number) => IModelDecoration[] | null (lineNumber: number): IModelDecoration[] | null not declared Get all the decorations on a line (filtering out decorations from other editors).
getDecorationsInRange yes (range: Range) => IModelDecoration[] | null (range: Range): IModelDecoration[] | null not declared Get all the decorations for a range (filtering out decorations from other editors).
deltaDecorations yes (oldDecorations: string[], newDecorations: IModelDeltaDecoration[]) => string[] (oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] not declared All decorations added through this call will get the ownerId of this editor.
removeDecorations yes (decorationIds: string[]) => void (decorationIds: string[]): void not declared Remove previously added decorations.
getLayoutInfo yes () => EditorLayoutInfo (): EditorLayoutInfo not declared Get the layout info for the editor.
getVisibleRanges yes () => Range[] (): Range[] not declared Returns the ranges that are currently visible. Does not account for horizontal scrolling.
getTopForLineNumber yes (lineNumber: number) => number (lineNumber: number): number not declared Get the vertical position (top offset) for the line's top w.r.t. to the first line.
getBottomForLineNumber yes (lineNumber: number) => number (lineNumber: number): number not declared Get the vertical position (top offset) for the line's bottom w.r.t. to the first line.
getTopForPosition yes (lineNumber: number, column: number) => number (lineNumber: number, column: number): number not declared Get the vertical position (top offset) for the position w.r.t. to the first line.
getContainerDomNode yes () => HTMLElement (): HTMLElement not declared Returns the editor's container dom node
getDomNode yes () => HTMLElement | null (): HTMLElement | null not declared Returns the editor's dom node
addContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.
layoutContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
removeContentWidget yes (widget: IContentWidget) => void (widget: IContentWidget): void not declared Remove a content widget.
addOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.
layoutOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
removeOverlayWidget yes (widget: IOverlayWidget) => void (widget: IOverlayWidget): void not declared Remove an overlay widget.
changeViewZones yes (callback: (accessor: IViewZoneChangeAccessor) => void) => void (callback: (accessor: IViewZoneChangeAccessor) => void): void not declared Change the view zones. View zones are lost when a new model is attached to the editor.
getOffsetForColumn yes (lineNumber: number, column: number) => number (lineNumber: number, column: number): number not declared Get the horizontal position (left offset) for the column w.r.t to the beginning of the line. This method works only if the line `lineNumber` is currently rendered (in the editor's viewport). Use this method with caution.
render yes (forceRedraw?: boolean | undefined) => void (forceRedraw?: boolean | undefined): void not declared Force an editor render now.
getTargetAtClientPoint yes (clientX: number, clientY: number) => IMouseTarget | null (clientX: number, clientY: number): IMouseTarget | null not declared Get the hit test target at coordinates `clientX` and `clientY`. The coordinates are relative to the top-left of the viewport.
getScrolledVisiblePosition yes (position: IPosition) => { top: number; left: number; height: number; } | null (position: IPosition): { top: number; left: number; height: number; } | null not declared Get the visible position for `position`. The result position takes scrolling into account and is relative to the top left corner of the editor. Explanation 1: the results of this method will change for the same `position` if the user scrolls the editor. Explanation 2: the results of this method will not change if the container of the editor gets repositioned. Warning: the results of this method are inaccurate for positions that are outside the current editor viewport.
applyFontInfo yes (target: HTMLElement) => void (target: HTMLElement): void not declared Apply the same font settings as the editor to `target`.
setBanner yes (bannerDomNode: HTMLElement | null, height: number) => void (bannerDomNode: HTMLElement | null, height: number): void not declared
onDidDispose yes (listener: () => void) => IDisposable (listener: () => void): IDisposable not declared An event emitted when the editor has been disposed.
dispose yes () => void (): void not declared Dispose the editor.
getId yes () => string (): string not declared Get a unique id for this editor instance.
getEditorType yes () => string (): string not declared Get the editor type. Please see `EditorType`. This is to avoid an instanceof check
layout yes (dimension?: IDimension | undefined) => void (dimension?: IDimension | undefined): void not declared Instructs the editor to remeasure its container. This method should be called when the container of the editor gets resized. If a dimension is passed in, the passed in value will be used.
focus yes () => void (): void not declared Brings browser focus to the editor text
hasTextFocus yes () => boolean (): boolean not declared Returns true if the text inside this editor is focused (i.e. cursor is blinking).
getSupportedActions yes () => IEditorAction[] (): IEditorAction[] not declared Returns all actions associated with this editor.
getVisibleColumnFromPosition yes (position: IPosition) => number (position: IPosition): number not declared Given a position, returns a column number that takes tab-widths into account.
getPosition yes () => Position | null (): Position | null not declared Returns the primary position of the cursor.
setPosition yes (position: IPosition, source?: string | undefined) => void (position: IPosition, source?: string | undefined): void not declared Set the primary position of the cursor. This will remove any secondary cursors.
revealLine yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line.
revealLineInCenter yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line centered vertically.
revealLineInCenterIfOutsideViewport yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
revealLineNearTop yes (lineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition.
revealPosition yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position.
revealPositionInCenter yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position centered vertically.
revealPositionInCenterIfOutsideViewport yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.
revealPositionNearTop yes (position: IPosition, scrollType?: ScrollType | undefined) => void (position: IPosition, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a position close to the top of the viewport, optimized for viewing a code definition.
getSelection yes () => Selection | null (): Selection | null not declared Returns the primary selection of the editor.
getSelections yes () => Selection[] | null (): Selection[] | null not declared Returns all the selections of the editor.
setSelection yes { (selection: IRange, source?: string | undefined): void; (selection: Range, source?: string | undefined): void; (selection: ISelection, source?: string | undefined): void; (selection: Selection, source?: string | undefined): void; } (selection: IRange, source?: string | undefined): void; (selection: Range, source?: string | undefined): void; (selection: ISelection, source?: string | undefined): void; (selection: Selection, source?: string | undefined): void not declared Set the primary selection of the editor. This will remove any secondary cursors.
setSelections yes (selections: readonly ISelection[], source?: string | undefined) => void (selections: readonly ISelection[], source?: string | undefined): void not declared Set the selections for all the cursors of the editor. Cursors will be removed or added, as necessary.
revealLines yes (startLineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (startLineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines.
revealLinesInCenter yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines centered vertically.
revealLinesInCenterIfOutsideViewport yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.
revealLinesNearTop yes (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined) => void (lineNumber: number, endLineNumber: number, scrollType?: ScrollType | undefined): void not declared Scroll vertically as necessary and reveal lines close to the top of the viewport, optimized for viewing a code definition.
revealRange yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range.
revealRangeInCenter yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range centered vertically.
revealRangeAtTop yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.
revealRangeInCenterIfOutsideViewport yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.
revealRangeNearTop yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition.
revealRangeNearTopIfOutsideViewport yes (range: IRange, scrollType?: ScrollType | undefined) => void (range: IRange, scrollType?: ScrollType | undefined): void not declared Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition. Only if it lies outside the viewport.
trigger yes (source: string | null | undefined, handlerId: string, payload: any) => void (source: string | null | undefined, handlerId: string, payload: any): void not declared Directly trigger a handler or an editor action.
createDecorationsCollection yes (decorations?: IModelDeltaDecoration[] | undefined) => IEditorDecorationsCollection (decorations?: IModelDeltaDecoration[] | undefined): IEditorDecorationsCollection not declared Create a collection of decorations. All decorations added through this collection will get the ownerId of the editor (meaning they will not show up in other editors). These decorations will be automatically cleared when the editor's model changes.

KvSchemaForm

Import: @kelvininc/react-ui-components/client. Source · Usage.

Signature: <T, S extends StrictRJSFSchema = RJSFSchema>({ customClass, liveValidate, formData: formDataProp, submittedData, uiSchema, allowDiscardChanges, allowResetToDefaults, onChange, validator: validatorProp, formReference, disabled, applyDefaults, schema: schemaProp, omitExtraData, liveOmit, displayErrors, showErrorsSwitch, extraErrors: extraErrorsProp, extraErrorsBlockSubmit, transformErrors: transformErrorsProp, humanizeErrors, ...otherProps }: SchemaFormProps<T, S, SchemaFormContext>): Element.

Prop Required Type Call signatures Declared default Description
_internalFormWrapper no ElementType | undefined not declared _internalFormWrapper is currently used by the semantic-ui theme to provide a custom wrapper around `` that supports the proper rendering of those themes. To use this prop, one must pass a component that takes two props: `children` and `as`. That component, at minimum, should render the `children` inside of a tag unless `as` is provided, in which case, use the `as` prop in place of ``. i.e.: ``` export default function InternalForm({ children, as }) { const FormTag = as || 'form'; return {children}; } ``` Use at your own risk as this prop is private and may change at any time without notice.
acceptCharset no string | undefined not declared The value of this prop will be passed to the `accept-charset` HTML attribute on the form
acceptcharset no string | undefined not declared The value of this prop will be passed to the `accept-charset` HTML attribute on the form
action no string | undefined not declared The value of this prop will be passed to the `action` HTML attribute on the form NOTE: this just renders the `action` attribute in the HTML markup. There is no real network request being sent to this `action` on submit. Instead, react-jsonschema-form catches the submit event with `event.preventDefault()` and then calls the `onSubmit` function, where you could send a request programmatically with `fetch` or similar.
allowDiscardChanges no boolean | undefined not declared
allowResetToDefaults no boolean | undefined not declared
applyDefaults no EApplyDefaults | undefined EApplyDefaults.All Optional enumerated flag controlling how empty object fields and array fields where `minItems` is set are populated. Default: `All`; - `All`: Legacy behavior - set default when there is a primitive value, an non-empty object field, or the field itself is required | - `RequiredOnly`: Only sets default when a value is an object and its parent field is required, or it is a primitive value and it is required | - `Never`: Does not set defaults |
autoComplete no string | undefined not declared The value of this prop will be passed to the `autocomplete` HTML attribute on the form
children no ReactNode not declared The optional children for the form, if provided, it will replace the default `SubmitButton`
className no string | undefined not declared The value of this prop will be passed to the `class` HTML attribute on the form
customClass no CustomCssClass | undefined not declared
customValidate no CustomValidator<T, S, SchemaFormContext> | undefined (formData: T | undefined, errors: FormValidation<T>, uiSchema?: UiSchema<T, S, SchemaFormContext> | undefined): FormValidation<T> not declared Formerly the `validate` prop; Takes a function that specifies custom validation rules for the form
disabled no boolean | undefined not declared It's possible to disable the whole form by setting the `disabled` prop. The `disabled` prop is then forwarded down to each field of the form. If you just want to disable some fields, see the `ui:disabled` parameter in `uiSchema`
displayErrors no boolean | undefined not declared If set to `true`, the form will always display error messages below the corresponding fields. Default: `false`, meaning that errors will be displayed only after form submission or when they are touched.
enctype no string | undefined not declared The value of this prop will be passed to the `enctype` HTML attribute on the form
experimental_customMergeAllOf no Experimental_CustomMergeAllOf<S> | undefined (schema: S): S not declared Optional function that allows for custom merging of `allOf` schemas
experimental_defaultFormStateBehavior no Experimental_DefaultFormStateBehavior | undefined not declared Optional configuration object with flags, if provided, allows users to override default form state behavior Currently only affecting minItems on array fields and handling of setting defaults based on the value of `emptyObjectFields`
extraErrors no ErrorSchema<T> | undefined not declared This prop allows passing in custom errors that are augmented with the existing JSON Schema errors on the form; it can be used to implement asynchronous validation. By default, these are non-blocking errors, meaning that you can still submit the form when these are the only errors displayed to the user.
extraErrorsBlockSubmit no boolean | undefined not declared If set to true, causes the `extraErrors` to become blocking when the form is submitted
fields no RegistryFieldsType<T, S, SchemaFormContext> | undefined not declared The dictionary of registered fields in the form
focusOnFirstError no boolean | ((error: RJSFValidationError) => void) | undefined not declared If set to true, then the first field with an error will receive the focus when the form is submitted with errors
formContext no SchemaFormContext | undefined not declared You can provide a `formContext` object to the form, which is passed down to all fields and widgets. Useful for implementing context aware fields and widgets. NOTE: Setting `{readonlyAsDisabled: false}` on the formContext will make the antd theme treat readOnly fields as disabled.
formData no T | undefined not declared The data for the form, used to prefill a form with existing data
formReference no RefObject<Form<T, S, SchemaFormContext>> | undefined not declared
humanizeErrors no boolean | undefined true Rewrite validator messages into readable sentences. Defaults to true.
id no string | undefined not declared The value of this prop will be passed to the `id` HTML attribute on the form
idPrefix no string | undefined not declared To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids; Default is `root`
idSeparator no string | undefined not declared To avoid using a path separator that is present in field names, it is possible to change the separator used for ids (Default is `_`)
liveOmit no boolean | undefined true If `omitExtraData` and `liveOmit` are both set to true, then extra form data values that are not in any form field will be removed whenever `onChange` is called. Set to `false` by default
liveValidate no boolean | undefined not declared If set to true, the form will perform validation and show any validation errors whenever the form data is changed, rather than just on submit
method no string | undefined not declared The value of this prop will be passed to the `method` HTML attribute on the form
name no string | undefined not declared The value of this prop will be passed to the `name` HTML attribute on the form
noHtml5Validate no boolean | undefined not declared If set to true, turns off HTML5 validation on the form; Set to `false` by default
noValidate no boolean | undefined not declared If set to true, turns off all validation. Set to `false` by default
omitExtraData no boolean | undefined true If set to true, then extra form data values that are not in any form field will be removed whenever `onSubmit` is called. Set to `false` by default.
onBlur no ((id: string, data: any) => void) | undefined (id: string, data: any): void not declared Sometimes you may want to trigger events or modify external state when a field has been touched, so you can pass an `onBlur` handler, which will receive the id of the input that was blurred and the field value
onChange no ((data: IChangeEvent<T, S, SchemaFormContext>, id?: string | undefined) => void) | undefined (data: IChangeEvent<T, S, SchemaFormContext>, id?: string | undefined): void not declared If you plan on being notified every time the form data are updated, you can pass an `onChange` handler, which will receive the same args as `onSubmit` any time a value is updated in the form. Can also return the `id` of the field that caused the change
onError no ((errors: RJSFValidationError[]) => void) | undefined (errors: RJSFValidationError[]): void not declared To react when submitted form data are invalid, pass an `onError` handler. It will be passed the list of encountered errors
onFocus no ((id: string, data: any) => void) | undefined (id: string, data: any): void not declared Sometimes you may want to trigger events or modify external state when a field has been focused, so you can pass an `onFocus` handler, which will receive the id of the input that is focused and the field value
onSubmit no ((data: IChangeEvent<T, S, SchemaFormContext>, event: FormEvent<any>) => void) | undefined (data: IChangeEvent<T, S, SchemaFormContext>, event: FormEvent<any>): void not declared You can pass a function as the `onSubmit` prop of your `Form` component to listen to when the form is submitted and its data are valid. It will be passed a result object having a `formData` attribute, which is the valid form data you're usually after. The original event will also be passed as a second parameter
readonly no boolean | undefined not declared It's possible to make the whole form read-only by setting the `readonly` prop. The `readonly` prop is then forwarded down to each field of the form. If you just want to make some fields read-only, see the `ui:readonly` parameter in `uiSchema`
ref no Ref<Form<T, S, SchemaFormContext>> | undefined not declared Support receiving a React ref to the Form
schema yes S not declared The JSON schema object for the form
showErrorList no false | "top" | "bottom" | undefined not declared When this prop is set to `top` or 'bottom', a list of errors (or the custom error list defined in the `ErrorList`) will also show. When set to false, only inline input validation errors will be shown. Set to `top` by default
showErrorsSwitch no boolean | undefined false If set to `true`, it will display the switch that allows users to toggle the visibility of all error messages. Default: `false`, meaning that the switch will not be displayed.
submittedData no T | undefined not declared
tagName no ElementType | undefined not declared It's possible to change the default `form` tag name to a different HTML tag, which can be helpful if you are nesting forms. However, native browser form behaviour, such as submitting when the `Enter` key is pressed, may no longer work
target no string | undefined not declared The value of this prop will be passed to the `target` HTML attribute on the form
templates no (Partial<Omit<TemplatesType<T, S, SchemaFormContext>, "ButtonTemplates">> & { ButtonTemplates?: Partial<{ SubmitButton: ComponentType<SubmitButtonProps<T, S, SchemaFormContext>>; AddButton: ComponentType<IconButtonProps<T, S, SchemaFormContext>>; CopyButton: ComponentType<IconButtonProps<T, S, SchemaFormContext>>; MoveDownButton: ComponentType<IconButtonProps<T, S, SchemaFormContext>>; MoveUpButton: ComponentType<IconButtonProps<T, S, SchemaFormContext>>; RemoveButton: ComponentType<IconButtonProps<T, S, SchemaFormContext>>; }> | undefined; }) | undefined not declared The dictionary of registered templates in the form; Partial allows a subset to be provided beyond the defaults
transformErrors no ErrorTransformer<T, S, SchemaFormContext> | undefined (errors: RJSFValidationError[], uiSchema?: UiSchema<T, S, SchemaFormContext> | undefined): RJSFValidationError[] not declared A function can be passed to this prop in order to make modifications to the default errors resulting from JSON Schema validation
translateString no ((stringKey: TranslatableString, params?: string[] | undefined) => string) | undefined (stringKey: TranslatableString, params?: string[] | undefined): string not declared Optional string translation function, if provided, allows users to change the translation of the RJSF internal strings. Some strings contain replaceable parameter values as indicated by `%1`, `%2`, etc. The number after the `%` indicates the order of the parameter. The ordering of parameters is important because some languages may choose to put the second parameter before the first in its translation.
uiSchema no UiSchema<T, S, SchemaFormContext> | undefined {} The uiSchema for the form
validator no ValidatorType<T, S, SchemaFormContext> | undefined not declared An implementation of the `ValidatorType` interface that is needed for form validation to work
widgets no RegistryWidgetsType<T, S, SchemaFormContext> | undefined not declared The dictionary of registered widgets in the form

ModalOverlay

Import: @kelvininc/react-ui-components/client. Source.

Signature: ({ rootId, isOpen, ...otherProps }: ModalOverlayProps): ReactPortal | null.

Prop Required Type Call signatures Declared default Description
class no string | undefined not declared
className no string | undefined not declared
customClass no CustomCssClass | undefined '' (optional) Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. It is also valid to provide CssClassMap with boolean logic.
headerTitle no string | undefined not declared (optional) Defines the modal title label
isOpen yes boolean not declared
onClickClose no ((event: KvModalCustomEvent<MouseEvent>) => void) | undefined (event: KvModalCustomEvent<MouseEvent>): void not declared Emitted when the close button is clicked
onClickOverlay no ((event: KvModalCustomEvent<MouseEvent>) => void) | undefined (event: KvModalCustomEvent<MouseEvent>): void not declared Emitted when the overlay container is clicked
onEscapeKeyPressed no ((event: KvModalCustomEvent<KeyboardEvent>) => void) | undefined (event: KvModalCustomEvent<KeyboardEvent>): void not declared Emitted when the escape key is pressed
rootId no string | undefined DEFAULT_MODAL_ROOT_ID
showCloseButton no boolean | undefined true (optional) Defines if the modal shows the close button
showOverlay no boolean | undefined true (optional) Defines if the modal has an overlay background
style no { [key: string]: any; } | undefined not declared

ToasterContainer

Import: @kelvininc/react-ui-components/client. Source.

Signature: ({ rootId, isOpen, children, ...otherProps }: PropsWithChildren<ToasterContainerProps>): ReactPortal | null.

Prop Required Type Call signatures Declared default Description
closable no boolean | undefined true (optional) If true the toaster has a close button
description no string | undefined not declared (optional) Secondary message to display
header yes string not declared (required) Main message to display
isOpen yes boolean not declared
onAfterClose no ((event: KvToasterCustomEvent<void>) => void) | undefined (event: KvToasterCustomEvent<void>): void not declared Emiited after the toaster has closed
onAfterOpen no ((event: KvToasterCustomEvent<void>) => void) | undefined (event: KvToasterCustomEvent<void>): void not declared Emiited after the toaster has opened
onClickCloseButton no ((event: KvToasterCustomEvent<MouseEvent>) => void) | undefined (event: KvToasterCustomEvent<MouseEvent>): void not declared Emitted when close button is clicked
onTtlExpired no ((event: KvToasterCustomEvent<CloseEvent>) => void) | undefined (event: KvToasterCustomEvent<CloseEvent>): void not declared Emitted when ttl is defined and expires
rootId no string | undefined DEFAULT_ROOT_ID
ttl no number | undefined not declared (optional) Time to live of the toaster
type yes EToasterType not declared (required) Type of toaster