Core Exports
These exports are available from @vibeflui/core.
Components
| Export | Kind | Purpose |
|---|---|---|
FluiKit | component | Full schema runtime. |
FluiKitProvider | component | Runtime context for registry, providers, messages, plugins, permissions, themes, and adapters. |
FluiKitForm | component | Direct form renderer for a normalized schema. |
FluiKitTable | component | Direct table renderer for a normalized schema. |
FluiKitField | component | Single field renderer. |
FluiKitAction | component | Single action renderer. |
FluiKitDetail | component | Detail view renderer. |
FluiKitFeedback | component | Inline or modal feedback renderer. |
FluiKitModal | component | Modal surface. |
FluiKitDrawer | component | Drawer surface. |
FluiKitConfirmDialog | component | Confirm dialog surface. |
FluiKitCard | component | Card primitive. |
FluiKitTab | component | Tab primitive. |
FluiKitDashboard | component | Dashboard/card renderer. |
Hooks
| Export | Kind | Purpose |
|---|---|---|
useFluiKitContext | hook | Reads the current FluiKit runtime context (registry, providers, messages, plugins, permissions, theme, adapters) from FluiKitProvider. |
Registry and plugins
| Export | Kind | Purpose |
|---|---|---|
createRegistry | function | Creates a runtime registry object. |
mergeRuntimeRegistry | function | Merges runtime registry objects. |
mergeRegistrySlot | function | Merges one registry slot. |
listRegistryKeys | function | Lists keys in a registry slot. |
resolveRegistryValue | function | Resolves one registry value. |
validateValuesWithRegistry | function | Runs built-in and registry validators. |
transformValuesWithRegistry | function | Applies field and request transformers. |
applyComputedValues | function | Applies computed field resolvers. |
createFluiKitPlugin | function | Creates a plugin definition. |
applyFluiKitPlugins | function | Applies plugin registry/messages/providers/themes/adapters. |
collectPluginConflictWarnings | function | Collects plugin conflict warnings. |
pluginRegistry | function | Extracts a plugin's runtime registry. |
Schema and operation utilities
| Export | Kind | Purpose |
|---|---|---|
fluiKitConfigSchema | Zod schema | Runtime validation schema. |
normalizeSchema | function | Normalizes a public schema into runtime shape. |
validateSchema | function | Validates a schema. |
migrateSchema | function | Runs built-in schema migrations. |
builtInSchemaMigrations | array | Built-in schema migration list. |
compareVersions | function | Compares semantic version strings for migrations. |
generateResource | function | Generates a resource schema from input. |
executeOperation | function | Executes list/detail/create/update/delete/action operation flow. |
resolveAction | function | Resolves an action to handler or endpoint execution. |
resolveEndpoint | function | Resolves endpoint configuration and identity params. |
validateFieldValue | function | Runs built-in field validation rules. |
isFieldVisible | function | Resolves field visibility for create/edit/view modes. |
normalizeOptions | function | Normalizes option-like values. |
resolveFieldOptions | function | Resolves static, endpoint, and registry-loaded options. |
resolveBackendFeedbackStatus | function | Maps backend-style result to feedback status. |
resolveFeedbackOutcome | function | Resolves feedback status with fallback. |
extractBackendMessage | function | Reads backend message from response-like payload. |
resolveMessage | function | Resolves UI message text. |
inspectSchema | function | Builds schema inspection metadata. |
createEndpointProvider | function | Creates the built-in endpoint-backed provider. |
executeEndpointRequest | function | Executes a resolved endpoint request. |
FluiKitEndpointError | class | Error type thrown for failed endpoint responses. |
Table and theme utilities
| Export | Kind | Purpose |
|---|---|---|
buildTableQueryState | function | Builds table query state. |
createInitialColumnFilters | function | Creates initial table filter state. |
createInitialPagination | function | Creates initial pagination state. |
createInitialSorting | function | Creates initial sorting state. |
tableQueryToProviderQuery | function | Maps table state to provider query. |
defaultThemePreset | object | Default theme preset. |
tailAdminThemePreset | object | TailAdmin theme preset. |
fluiKitThemePresets | object | Available theme presets. |
getThemePreset | function | Reads a theme preset. |
resolveThemeClassName | function | Resolves a theme class slot. |
resolveThemeConfig | function | Resolves theme config. |
resolveThemeVariant | function | Resolves theme variant class. |
fluiKitAdapterPresets | object | Adapter preset map. |
adapterThemePreset | function | Resolves the theme preset implied by an adapter. |
resolveAdapterConfig | function | Resolves 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";