Skip to main content

All Exports

This is an appendix — a flat index of every named export from @widgemo/widgemo-core. Use it when you've seen an import somewhere and want to know where it's documented.

For usage, see the linked reference page for each entry.

Reading This Page​

ColumnMeaning
Export / TypePublic name exported from @widgemo/widgemo-core
KindRuntime shape (Component, Function, Hook, Object, namespace)
DescriptionShort contract summary
DocsPrimary reference page

Components​

ExportKindDescriptionDocs
WidgemoComponentThe main component.Widgemo Props
WidgemoThemeProviderComponentTheme context provider. Wrap your app or subtree to share a named theme.Theme API
TooltipComponentShared tooltip UI primitive used inside custom renderers.Extension API — UI Primitives

Namespaces​

ExportKindDescriptionDocs
widgemoRegistryNamespace objectPlugin system — register and resolve icons, field types, renderAs renderers, hooks, and modes.Extension API — widgemoRegistry
widgemoColorsNamespace objectColor utilities — lighten/darken, contrast, palette generation.Utilities — widgemoColors
advancedNamespace objectLower-level renderer components and hooks for custom layout composition. May change between minor versions.Extension API — advanced

Action utilities​

ExportKindDescriptionDocs
coreActionsObjectBuilt-in action presets (add, refresh, viewToggle, export, import, settings, view, edit, delete, filter, sort, search). Spread a preset and override only per-widget fields.Action Config — coreActions

Temporal utilities​

ExportKindDescriptionDocs
parseTemporalValueFunctionParse a raw value into a Date given a TemporalParseMode. Returns null on failure.Utilities — Temporal utilities
parseDurationValueFunctionConvert a raw duration number to milliseconds given a DurationUnit.Utilities — Temporal utilities
isTemporalParseModeFunctionType-guard — returns true if a value is a valid TemporalParseMode string.Utilities — Temporal utilities

Icon utilities​

ExportKindDescriptionDocs
defaultRenderWidgemoIconFunctionStateless icon renderer — does not touch the registry. Safe for SSG/SSR.Extension API — UI Primitives

General utilities​

ExportKindDescriptionDocs
isValidEmailFunctionReturns true if a value is a syntactically valid email address.Utilities — General utilities
generateIdFunctionGenerate a stable ID string.Utilities — General utilities

Theme utilities​

ExportKindDescriptionDocs
getThemeFunctionRetrieve a registered theme by name.Theme API
registerThemeFunctionRegister a custom WidgemoTheme.Theme API
mergeZoneThemeFunctionMerge a partial ZoneTheme into a resolved theme.Theme API
defaultWidgemoThemeObjectPublic default light preset alias used as a base theme object.Theme API
useWidgemoThemeHookReact hook — read the current theme from context.Theme API

Types​

Core props and config​

TypeDescriptionDocs
WidgemoPropsComponent prop contract.Widgemo Props
WidgemoConfigCentral configuration object.Widgemo Config
EntityRecord<string, unknown> — one data row.Widgemo Props — data
ZoneConfigHeader/footer zone shape.Zone Config
ZoneLayoutLayout options for zone header/footer.Zone Config — ZoneLayout
ContentConfigContent zone shape.Content Config
ContainerFrameOuter shell chrome controls.Widgemo Config — Container Frame
DevModeConfigDev inspector overlay config.Widgemo Config — devMode

Field config​

TypeDescriptionDocs
FieldConfigField definition shape.Field Config
RenderAsOptionsUnion of all renderAsOptions shapes.Field Config
BaseRenderAsOptionsBase shape common to all renderAs options.Field Config
LinkRenderAsOptionsOptions for renderAs: 'link'.Field Config
ProgressRenderAsOptionsOptions for renderAs: 'progress'.Field Config
RatingRenderAsOptionsOptions for renderAs: 'rating'.Field Config
CurrencyRenderAsOptionsOptions for renderAs: 'currency'.Field Config
BadgeRenderAsOptionsOptions for renderAs: 'badge'.Field Config
JsonPreviewRenderAsOptionsOptions for renderAs: 'jsonPreview'.Field Config
DeltaValueRenderAsOptionsOptions for renderAs: 'deltaValue'.Field Config
DeltaValuePaletteColor palette for delta value renderers.Field Config
SparkTrendRenderAsOptionsOptions for renderAs: 'sparkTrend'.Field Config
ScoreMeterRenderAsOptionsOptions for renderAs: 'scoreMeter'.Field Config
ScoreBandScore band definition for scoreMeter.Field Config
CompositionBarRenderAsOptionsOptions for renderAs: 'compositionBar'.Field Config
CompositionBarSegmentSegment definition for compositionBar.Field Config
DateRenderAsOptionsOptions for renderAs: 'date'.Date Renderer
TimeRenderAsOptionsOptions for renderAs: 'time'.Time Renderer
DatetimeRenderAsOptionsOptions for renderAs: 'datetime'.Datetime Renderer
TimestampRenderAsOptionsOptions for renderAs: 'timestamp'.Timestamp Renderer
DurationRenderAsOptionsOptions for renderAs: 'duration'.Duration Renderer
TemporalRenderAsOptionsBase shape for all temporal renderAs options.Field Config
TemporalParseMode'epoch-ms' | 'epoch-sec' | 'iso-date' | 'iso-datetime' | 'iso-time' | 'any'Utilities — Temporal utilities
TemporalTimeZoneTimezone string type used in temporal renderers.Datetime Renderer
DurationUnit'ms' | 'sec' | 'min' | 'hour' | 'day'Duration Renderer
DurationHumanizedUnitUnit labels for humanized duration display.Duration Renderer

Item config​

TypeDescriptionDocs
ItemConfigItem rendering shape.Item Config
ItemLayoutLayout shape for items in a mode.Item Config
ItemStylePer-item conditional style config.Item Config
ItemSectionSection definition for multi-section item layouts.Item Config
ItemTemplateTemplate shape for custom item rendering.Item Config
SectionConfigSection config within an item, including optional className for section-level styling hooks.Item Config

Action config​

TypeDescriptionDocs
ActionConfigAction definition shape.Action Config
IconConfigIcon definition used in actions and zone headers.Action Config

Mode config​

TypeDescriptionDocs
ModeConfigUnion type for all mode config shapes.Content Config
ModeLayoutLayout shape for content zone modes.Content Config
TableModeConfigTable-mode-specific config.Content Config
BoardModeConfigBoard-mode-specific config.Content Config
BoardColumnsConfigColumn set definition for board mode.Content Config
BoardColumnConfigSingle column definition for board mode.Content Config
BoardAxisItemConfigAxis item for board mode.Content Config
BoardSwimlaneConfigSwimlane definition for board mode.Content Config
BoardSwimlanesConfigSwimlane set for board mode.Content Config
ChartModeConfigChart-mode-specific config.Content Config
ChartSeriesConfigSeries definition for chart mode.Content Config
ChartSeriesTypeUnion of supported chart series types.Content Config
ChartTooltipContextContext passed to chart tooltip renderers.Content Config
ChartTooltipPositionPosition type for chart tooltips.Content Config

Content / sorting / filtering​

TypeDescriptionDocs
GestureConfigGesture handler definition.Content Config — Gestures
GroupingConfigGrouping definition for content zones.Content Config
SortConfigSort definition.Content Config
SortDirection'asc' | 'desc'Content Config
FilterOperatorComparison operator for static filter rules.Content Config
StaticFilterRuleSingle static filter rule applied to data.Content Config
AggregateTypeAggregate function type (sum, avg, etc.).Content Config

Interaction types​

TypeDescriptionDocs
InteractionContextPayload received by all action and gesture handlers.Extension API — InteractionContext
InteractionKindDiscriminant for interaction type.Extension API — InteractionContext
InteractionScopeScope descriptor for an interaction.Extension API — InteractionContext
InteractionEventHandlerFunction type for interactions.onEvent.Extension API — InteractionContext
InteractionBoardLocationBoard drag/drop location with columnId, optional swimlaneValue, and optional index.Extension API — InteractionContext

Registry entry types​

TypeDescriptionDocs
RenderAsRegistryEntryShape for registering a custom renderAs renderer.Extension API
ModeRegistryEntryShape for registering a custom mode.Extension API
IconRegistryEntryShape for registering a custom icon.Extension API
FieldTypeRegistryEntryShape for registering a custom field type.Extension API
HookRegistryEntryShape for registering a lifecycle hook.Extension API

Theme types​

TypeDescriptionDocs
WidgemoThemeFull theme shape.Theme API
ZoneThemePer-zone theme overrides.Theme API
ActionThemeAction-specific theme overrides.Theme API

Tooltip types​

TypeDescriptionDocs
TooltipPropsProps for the Tooltip component.Extension API — UI Primitives
TooltipPositionUnion of valid tooltip positions.Extension API — UI Primitives

Color utility types​

TypeDescriptionDocs
PaletteReturn type of widgemoColors.generatePalette.Utilities — widgemoColors
PaletteOptionsOptions for widgemoColors.generatePalette.Utilities — widgemoColors

Advanced state types​

TypeDescriptionDocs
AdvancedPaginationStateState shape returned by advanced.usePagination.Extension API — advanced
AdvancedFilterStateState shape returned by advanced.useFilter.Extension API — advanced

Other utility types​

TypeDescriptionDocs
RenderIconFunction type for icon render callbacks.Extension API

See Also​