VVibeFlui

Core Exports

These exports are available from @vibeflui/core.

Components

ExportKindPurpose
FluiKitcomponentFull schema runtime.
FluiKitProvidercomponentRuntime context for registry, providers, messages, plugins, permissions, themes, and adapters.
FluiKitFormcomponentDirect form renderer for a normalized schema.
FluiKitTablecomponentDirect table renderer for a normalized schema.
FluiKitFieldcomponentSingle field renderer.
FluiKitActioncomponentSingle action renderer.
FluiKitDetailcomponentDetail view renderer.
FluiKitFeedbackcomponentInline or modal feedback renderer.
FluiKitModalcomponentModal surface.
FluiKitDrawercomponentDrawer surface.
FluiKitConfirmDialogcomponentConfirm dialog surface.
FluiKitCardcomponentCard primitive.
FluiKitTabcomponentTab primitive.
FluiKitDashboardcomponentDashboard/card renderer.

Hooks

ExportKindPurpose
useFluiKitContexthookReads the current FluiKit runtime context (registry, providers, messages, plugins, permissions, theme, adapters) from FluiKitProvider.

Registry and plugins

ExportKindPurpose
createRegistryfunctionCreates a runtime registry object.
mergeRuntimeRegistryfunctionMerges runtime registry objects.
mergeRegistrySlotfunctionMerges one registry slot.
listRegistryKeysfunctionLists keys in a registry slot.
resolveRegistryValuefunctionResolves one registry value.
validateValuesWithRegistryfunctionRuns built-in and registry validators.
transformValuesWithRegistryfunctionApplies field and request transformers.
applyComputedValuesfunctionApplies computed field resolvers.
createFluiKitPluginfunctionCreates a plugin definition.
applyFluiKitPluginsfunctionApplies plugin registry/messages/providers/themes/adapters.
collectPluginConflictWarningsfunctionCollects plugin conflict warnings.
pluginRegistryfunctionExtracts a plugin's runtime registry.

Schema and operation utilities

ExportKindPurpose
fluiKitConfigSchemaZod schemaRuntime validation schema.
normalizeSchemafunctionNormalizes a public schema into runtime shape.
validateSchemafunctionValidates a schema.
migrateSchemafunctionRuns built-in schema migrations.
builtInSchemaMigrationsarrayBuilt-in schema migration list.
compareVersionsfunctionCompares semantic version strings for migrations.
generateResourcefunctionGenerates a resource schema from input.
executeOperationfunctionExecutes list/detail/create/update/delete/action operation flow.
resolveActionfunctionResolves an action to handler or endpoint execution.
resolveEndpointfunctionResolves endpoint configuration and identity params.
validateFieldValuefunctionRuns built-in field validation rules.
isFieldVisiblefunctionResolves field visibility for create/edit/view modes.
normalizeOptionsfunctionNormalizes option-like values.
resolveFieldOptionsfunctionResolves static, endpoint, and registry-loaded options.
resolveBackendFeedbackStatusfunctionMaps backend-style result to feedback status.
resolveFeedbackOutcomefunctionResolves feedback status with fallback.
extractBackendMessagefunctionReads backend message from response-like payload.
resolveMessagefunctionResolves UI message text.
inspectSchemafunctionBuilds schema inspection metadata.
createEndpointProviderfunctionCreates the built-in endpoint-backed provider.
executeEndpointRequestfunctionExecutes a resolved endpoint request.
FluiKitEndpointErrorclassError type thrown for failed endpoint responses.

Table and theme utilities

ExportKindPurpose
buildTableQueryStatefunctionBuilds table query state.
createInitialColumnFiltersfunctionCreates initial table filter state.
createInitialPaginationfunctionCreates initial pagination state.
createInitialSortingfunctionCreates initial sorting state.
tableQueryToProviderQueryfunctionMaps table state to provider query.
defaultThemePresetobjectDefault theme preset.
tailAdminThemePresetobjectTailAdmin theme preset.
fluiKitThemePresetsobjectAvailable theme presets.
getThemePresetfunctionReads a theme preset.
resolveThemeClassNamefunctionResolves a theme class slot.
resolveThemeConfigfunctionResolves theme config.
resolveThemeVariantfunctionResolves theme variant class.
fluiKitAdapterPresetsobjectAdapter preset map.
adapterThemePresetfunctionResolves the theme preset implied by an adapter.
resolveAdapterConfigfunctionResolves adapter config.

Common type exports

The package exports component prop types, schema types, provider types, registry types, action types, theme types, table types, form types, and inspector types.

TS
import type {
  FluiKitConfig,
  FluiKitProps,
  FluiKitProviderProps,
  FluiKitRuntimeRegistry,
  FluiKitActionConfig
} from "@vibeflui/core";