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
| Column | Meaning |
|---|---|
Export / Type | Public name exported from @widgemo/widgemo-core |
Kind | Runtime shape (Component, Function, Hook, Object, namespace) |
Description | Short contract summary |
Docs | Primary reference page |
Components
| Export | Kind | Description | Docs |
|---|---|---|---|
Widgemo | Component | The main component. | Widgemo Props |
WidgemoThemeProvider | Component | Theme context provider. Wrap your app or subtree to share a named theme. | Theme API |
Tooltip | Component | Shared tooltip UI primitive used inside custom renderers. | Extension API — UI Primitives |
Namespaces
| Export | Kind | Description | Docs |
|---|---|---|---|
widgemoRegistry | Namespace object | Plugin system — register and resolve icons, field types, renderAs renderers, hooks, and modes. | Extension API — widgemoRegistry |
widgemoColors | Namespace object | Color utilities — lighten/darken, contrast, palette generation. | Utilities — widgemoColors |
advanced | Namespace object | Lower-level renderer components and hooks for custom layout composition. May change between minor versions. | Extension API — advanced |
Action utilities
| Export | Kind | Description | Docs |
|---|---|---|---|
coreActions | Object | Built-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
| Export | Kind | Description | Docs |
|---|---|---|---|
parseTemporalValue | Function | Parse a raw value into a Date given a TemporalParseMode. Returns null on failure. | Utilities — Temporal utilities |
parseDurationValue | Function | Convert a raw duration number to milliseconds given a DurationUnit. | Utilities — Temporal utilities |
isTemporalParseMode | Function | Type-guard — returns true if a value is a valid TemporalParseMode string. | Utilities — Temporal utilities |
Icon utilities
| Export | Kind | Description | Docs |
|---|---|---|---|
defaultRenderWidgemoIcon | Function | Stateless icon renderer — does not touch the registry. Safe for SSG/SSR. | Extension API — UI Primitives |
General utilities
| Export | Kind | Description | Docs |
|---|---|---|---|
isValidEmail | Function | Returns true if a value is a syntactically valid email address. | Utilities — General utilities |
generateId | Function | Generate a stable ID string. | Utilities — General utilities |
Theme utilities
| Export | Kind | Description | Docs |
|---|---|---|---|
getTheme | Function | Retrieve a registered theme by name. | Theme API |
registerTheme | Function | Register a custom WidgemoTheme. | Theme API |
mergeZoneTheme | Function | Merge a partial ZoneTheme into a resolved theme. | Theme API |
defaultWidgemoTheme | Object | Public default light preset alias used as a base theme object. | Theme API |
useWidgemoTheme | Hook | React hook — read the current theme from context. | Theme API |
Types
Core props and config
| Type | Description | Docs |
|---|---|---|
WidgemoProps | Component prop contract. | Widgemo Props |
WidgemoConfig | Central configuration object. | Widgemo Config |
Entity | Record<string, unknown> — one data row. | Widgemo Props — data |
ZoneConfig | Header/footer zone shape. | Zone Config |
ZoneLayout | Layout options for zone header/footer. | Zone Config — ZoneLayout |
ContentConfig | Content zone shape. | Content Config |
ContainerFrame | Outer shell chrome controls. | Widgemo Config — Container Frame |
DevModeConfig | Dev inspector overlay config. | Widgemo Config — devMode |
Field config
| Type | Description | Docs |
|---|---|---|
FieldConfig | Field definition shape. | Field Config |
RenderAsOptions | Union of all renderAsOptions shapes. | Field Config |
BaseRenderAsOptions | Base shape common to all renderAs options. | Field Config |
LinkRenderAsOptions | Options for renderAs: 'link'. | Field Config |
ProgressRenderAsOptions | Options for renderAs: 'progress'. | Field Config |
RatingRenderAsOptions | Options for renderAs: 'rating'. | Field Config |
CurrencyRenderAsOptions | Options for renderAs: 'currency'. | Field Config |
BadgeRenderAsOptions | Options for renderAs: 'badge'. | Field Config |
JsonPreviewRenderAsOptions | Options for renderAs: 'jsonPreview'. | Field Config |
DeltaValueRenderAsOptions | Options for renderAs: 'deltaValue'. | Field Config |
DeltaValuePalette | Color palette for delta value renderers. | Field Config |
SparkTrendRenderAsOptions | Options for renderAs: 'sparkTrend'. | Field Config |
ScoreMeterRenderAsOptions | Options for renderAs: 'scoreMeter'. | Field Config |
ScoreBand | Score band definition for scoreMeter. | Field Config |
CompositionBarRenderAsOptions | Options for renderAs: 'compositionBar'. | Field Config |
CompositionBarSegment | Segment definition for compositionBar. | Field Config |
DateRenderAsOptions | Options for renderAs: 'date'. | Date Renderer |
TimeRenderAsOptions | Options for renderAs: 'time'. | Time Renderer |
DatetimeRenderAsOptions | Options for renderAs: 'datetime'. | Datetime Renderer |
TimestampRenderAsOptions | Options for renderAs: 'timestamp'. | Timestamp Renderer |
DurationRenderAsOptions | Options for renderAs: 'duration'. | Duration Renderer |
TemporalRenderAsOptions | Base shape for all temporal renderAs options. | Field Config |
TemporalParseMode | 'epoch-ms' | 'epoch-sec' | 'iso-date' | 'iso-datetime' | 'iso-time' | 'any' | Utilities — Temporal utilities |
TemporalTimeZone | Timezone string type used in temporal renderers. | Datetime Renderer |
DurationUnit | 'ms' | 'sec' | 'min' | 'hour' | 'day' | Duration Renderer |
DurationHumanizedUnit | Unit labels for humanized duration display. | Duration Renderer |
Item config
| Type | Description | Docs |
|---|---|---|
ItemConfig | Item rendering shape. | Item Config |
ItemLayout | Layout shape for items in a mode. | Item Config |
ItemStyle | Per-item conditional style config. | Item Config |
ItemSection | Section definition for multi-section item layouts. | Item Config |
ItemTemplate | Template shape for custom item rendering. | Item Config |
SectionConfig | Section config within an item, including optional className for section-level styling hooks. | Item Config |
Action config
| Type | Description | Docs |
|---|---|---|
ActionConfig | Action definition shape. | Action Config |
IconConfig | Icon definition used in actions and zone headers. | Action Config |
Mode config
| Type | Description | Docs |
|---|---|---|
ModeConfig | Union type for all mode config shapes. | Content Config |
ModeLayout | Layout shape for content zone modes. | Content Config |
TableModeConfig | Table-mode-specific config. | Content Config |
BoardModeConfig | Board-mode-specific config. | Content Config |
BoardColumnsConfig | Column set definition for board mode. | Content Config |
BoardColumnConfig | Single column definition for board mode. | Content Config |
BoardAxisItemConfig | Axis item for board mode. | Content Config |
BoardSwimlaneConfig | Swimlane definition for board mode. | Content Config |
BoardSwimlanesConfig | Swimlane set for board mode. | Content Config |
ChartModeConfig | Chart-mode-specific config. | Content Config |
ChartSeriesConfig | Series definition for chart mode. | Content Config |
ChartSeriesType | Union of supported chart series types. | Content Config |
ChartTooltipContext | Context passed to chart tooltip renderers. | Content Config |
ChartTooltipPosition | Position type for chart tooltips. | Content Config |
Content / sorting / filtering
| Type | Description | Docs |
|---|---|---|
GestureConfig | Gesture handler definition. | Content Config — Gestures |
GroupingConfig | Grouping definition for content zones. | Content Config |
SortConfig | Sort definition. | Content Config |
SortDirection | 'asc' | 'desc' | Content Config |
FilterOperator | Comparison operator for static filter rules. | Content Config |
StaticFilterRule | Single static filter rule applied to data. | Content Config |
AggregateType | Aggregate function type (sum, avg, etc.). | Content Config |
Interaction types
| Type | Description | Docs |
|---|---|---|
InteractionContext | Payload received by all action and gesture handlers. | Extension API — InteractionContext |
InteractionKind | Discriminant for interaction type. | Extension API — InteractionContext |
InteractionScope | Scope descriptor for an interaction. | Extension API — InteractionContext |
InteractionEventHandler | Function type for interactions.onEvent. | Extension API — InteractionContext |
InteractionBoardLocation | Board drag/drop location with columnId, optional swimlaneValue, and optional index. | Extension API — InteractionContext |
Registry entry types
| Type | Description | Docs |
|---|---|---|
RenderAsRegistryEntry | Shape for registering a custom renderAs renderer. | Extension API |
ModeRegistryEntry | Shape for registering a custom mode. | Extension API |
IconRegistryEntry | Shape for registering a custom icon. | Extension API |
FieldTypeRegistryEntry | Shape for registering a custom field type. | Extension API |
HookRegistryEntry | Shape for registering a lifecycle hook. | Extension API |
Theme types
| Type | Description | Docs |
|---|---|---|
WidgemoTheme | Full theme shape. | Theme API |
ZoneTheme | Per-zone theme overrides. | Theme API |
ActionTheme | Action-specific theme overrides. | Theme API |
Tooltip types
| Type | Description | Docs |
|---|---|---|
TooltipProps | Props for the Tooltip component. | Extension API — UI Primitives |
TooltipPosition | Union of valid tooltip positions. | Extension API — UI Primitives |
Color utility types
| Type | Description | Docs |
|---|---|---|
Palette | Return type of widgemoColors.generatePalette. | Utilities — widgemoColors |
PaletteOptions | Options for widgemoColors.generatePalette. | Utilities — widgemoColors |
Advanced state types
| Type | Description | Docs |
|---|---|---|
AdvancedPaginationState | State shape returned by advanced.usePagination. | Extension API — advanced |
AdvancedFilterState | State shape returned by advanced.useFilter. | Extension API — advanced |
Other utility types
| Type | Description | Docs |
|---|---|---|
RenderIcon | Function type for icon render callbacks. | Extension API |