@puckeditor/core 0.22.1 → 0.23.0-canary.7ca16bcb

package/dist/{index-B1b1cFug.d.ts → index-t7c1w81O.d.ts}

@@ -60,6 +60,89 @@ type FieldsSlice = {
     id: string | undefined;
 };
 
+/**
+ * Default messages for every hard-coded string shown in the Puck editor UI.
+ *
+ * Tokens follow a `{area}-{name}-{variant}` structure, where hyphens only
+ * separate segments (compound words within a segment are concatenated, e.g.
+ * `field-arrayitem-summary`).
+ */
+declare const defaultDictionary: {
+    readonly "header-publish": "Publish";
+    readonly "header-undo": "undo";
+    readonly "header-redo": "redo";
+    readonly "header-toggle-leftsidebar": "Toggle left sidebar";
+    readonly "header-toggle-rightsidebar": "Toggle right sidebar";
+    readonly "header-toggle-menubar": "Toggle menu bar";
+    readonly "action-selectparent": "Select parent";
+    readonly "action-duplicate": "Duplicate";
+    readonly "action-delete": "Delete";
+    readonly "label-page": "Page";
+    readonly "label-component": "Component";
+    readonly "outline-empty": "No items";
+    readonly "outline-collapse": "Collapse";
+    readonly "outline-expand": "Expand";
+    readonly "drawer-category-collapse": "Collapse {title}";
+    readonly "drawer-category-expand": "Expand {title}";
+    readonly "drawer-category-other": "Other";
+    readonly "canvas-noconfig": "No configuration for {type}";
+    readonly "field-readonly": "Read-only";
+    readonly "field-arrayitem-summary": "Item #{index}";
+    readonly "field-arrayitem-duplicate": "Duplicate";
+    readonly "field-arrayitem-delete": "Delete";
+    readonly "field-external-selectdata": "Select data";
+    readonly "field-external-search": "Search";
+    readonly "field-external-togglefilters": "Toggle filters";
+    readonly "field-external-item": "External item";
+    readonly "field-external-result-singular": "{count} result";
+    readonly "field-external-result-plural": "{count} results";
+    readonly "field-richtext-bold": "Bold";
+    readonly "field-richtext-italic": "Italic";
+    readonly "field-richtext-underline": "Underline";
+    readonly "field-richtext-strikethrough": "Strikethrough";
+    readonly "field-richtext-blockquote": "Blockquote";
+    readonly "field-richtext-code-inline": "Inline code";
+    readonly "field-richtext-code-block": "Code block";
+    readonly "field-richtext-list-bullet": "Bullet list";
+    readonly "field-richtext-list-ordered": "Ordered list";
+    readonly "field-richtext-horizontalrule": "Horizontal rule";
+    readonly "field-richtext-align-left": "Align left";
+    readonly "field-richtext-align-center": "Align center";
+    readonly "field-richtext-align-right": "Align right";
+    readonly "field-richtext-align-justify": "Justify";
+    readonly "field-richtext-select": "Select";
+    readonly "field-richtext-headingselect-1": "Heading 1";
+    readonly "field-richtext-headingselect-2": "Heading 2";
+    readonly "field-richtext-headingselect-3": "Heading 3";
+    readonly "field-richtext-headingselect-4": "Heading 4";
+    readonly "field-richtext-headingselect-5": "Heading 5";
+    readonly "field-richtext-headingselect-6": "Heading 6";
+    readonly "field-richtext-alignselect-left": "Left";
+    readonly "field-richtext-alignselect-center": "Center";
+    readonly "field-richtext-alignselect-right": "Right";
+    readonly "field-richtext-alignselect-justify": "Justify";
+    readonly "field-richtext-listselect-bullet": "Bullet list";
+    readonly "field-richtext-listselect-ordered": "Ordered list";
+    readonly "viewport-zoom-in": "Zoom viewport in";
+    readonly "viewport-zoom-out": "Zoom viewport out";
+    readonly "viewport-zoom-auto": "{zoom}% (Auto)";
+    readonly "viewport-toggle-menu": "Toggle viewport menu";
+    readonly "viewport-switch": "Switch to {label} viewport";
+    readonly "viewport-switch-default": "Switch viewport";
+    readonly "plugin-blocks": "Blocks";
+    readonly "plugin-outline": "Outline";
+    readonly "plugin-fields": "Fields";
+    readonly "plugin-components": "Components";
+    readonly "layout-maximize": "maximize";
+    readonly "layout-minimize": "minimize";
+    readonly "loader-loading": "loading";
+};
+type DictionaryKey = keyof typeof defaultDictionary;
+/**
+ * Override any of Puck's built-in UI strings, or provide your own custom strings.
+ */
+type Dictionary = Partial<Record<DictionaryKey, string> & Record<string, string>>;
+
 type Status = "LOADING" | "MOUNTED" | "READY";
 type ZoomConfig = {
     autoZoom: number;
@@ -100,6 +183,7 @@ type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserCon
     getComponentConfig: (type?: string) => ComponentConfig | null | undefined;
     onAction?: (action: PuckAction, newState: AppState, state: AppState) => void;
     metadata: Metadata;
+    dictionary: Dictionary;
     fields: FieldsSlice;
     history: HistorySlice;
     nodes: NodesSlice;
@@ -114,4 +198,4 @@ type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserCon
     } | null;
 };
 
-export type { AppStore as A, GetPermissions as G, HistorySlice as H, RefreshPermissions as R };
+export type { AppStore as A, Dictionary as D, GetPermissions as G, HistorySlice as H, RefreshPermissions as R };

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import { H as Field, J as FieldProps, y as DropZoneProps, m as Config, am as UserGenerics, D as Data, al as UiState, Y as OnAction, $ as Permissions, a0 as Plugin, _ as Overrides, N as FieldTransforms, a3 as PuckAction, ao as Viewports, Q as IframeConfig, R as InitialHistory, V as Metadata, a8 as ResolveDataTrigger, S as ItemSelector, i as ComponentData, a1 as PluginInternal } from './actions-Csn3gOP8.mjs';
 export { A as Adaptor, a as AppState, b as ArrayField, c as ArrayState, d as AsFieldProps, B as BaseData, e as BaseField, C as CacheOpts, f as ComponentConfig, g as ComponentConfigExtensions, h as ComponentConfigParams, j as ComponentDataMap, k as ComponentDataOptionalId, l as ComponentMetadata, n as ConfigParams, o as Content, p as CustomField, q as CustomFieldRender, r as DefaultComponentProps, s as DefaultComponents, t as DefaultRootFieldProps, u as DefaultRootProps, v as DefaultRootRenderProps, w as Direction, x as DragAxis, E as ExternalField, z as ExternalFieldWithAdaptor, F as ExtractConfigParams, G as ExtractField, I as FieldMetadata, K as FieldRenderFunctions, L as FieldTransformFn, M as FieldTransformFnParams, O as Fields, P as History, T as ItemWithId, U as MappedItem, W as NumberField, X as ObjectField, Z as OverrideKey, a4 as PuckComponent, a5 as PuckContext, a6 as PuckMetadata, a7 as RadioField, a9 as RichText, aa as RichtextField, ab as RootConfig, ac as RootData, ad as RootDataWithProps, ae as RootDataWithoutProps, af as SelectField, ag as Slot, ah as SlotComponent, ai as SlotField, aj as TextField, ak as TextareaField, an as Viewport, ap as WithChildren, aq as WithId, ar as WithPuckProps, as as WithSlotProps, at as overrideKeys } from './actions-Csn3gOP8.mjs';
+import { D as Dictionary, A as AppStore, G as GetPermissions, R as RefreshPermissions, H as HistorySlice } from './index-De5Tn61v.mjs';
 export { m as migrate, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-BrW9VQ_t.mjs';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { A as AppStore, G as GetPermissions, R as RefreshPermissions, H as HistorySlice } from './index-ClzBCbx_.mjs';
 import '@tiptap/react';
 import '@tiptap/extension-blockquote';
 import '@tiptap/extension-bold';
@@ -150,6 +150,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     };
     initialHistory?: InitialHistory;
     metadata?: Metadata;
+    dictionary?: Dictionary;
     height?: CSSProperties["height"];
     _experimentalFullScreenCanvas?: boolean;
     _experimentalVirtualization?: boolean;
@@ -276,6 +277,7 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
         hasPast: boolean;
         hasFuture: boolean;
     };
+    dictionary: Dictionary;
 };
 type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
 type UsePuckStore<UserConfig extends Config = Config> = PuckApi<UserConfig>;
@@ -297,14 +299,27 @@ declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<Use
  */
 declare function useGetPuck(): () => UsePuckStore<Config>;
 
-declare const blocksPlugin: () => Plugin;
+type BlocksPluginProps = {
+    label?: string;
+    icon?: ReactNode;
+};
+declare const blocksPlugin: (props?: BlocksPluginProps) => Plugin;
 
 declare const fieldsPlugin: (params?: {
     desktopSideBar?: "left" | "right";
+    label?: string;
+    icon?: ReactNode;
 }) => PluginInternal;
 
-declare const outlinePlugin: () => Plugin;
+type OutlinePluginProps = {
+    label?: string;
+    icon?: ReactNode;
+};
+declare const outlinePlugin: (props?: OutlinePluginProps) => Plugin;
 
-declare const legacySideBarPlugin: () => Plugin;
+declare const legacySideBarPlugin: (props?: {
+    outlineLabel?: string;
+    componentsLabel?: string;
+}) => Plugin;
 
-export { Action, ActionBar, AutoField, Button, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Group, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RichTextMenu, Separator, UiState, type UsePuckData, UserGenerics, Viewports, blocksPlugin, createUsePuck, fieldsPlugin, legacySideBarPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };
+export { Action, ActionBar, AutoField, type BlocksPluginProps, Button, ComponentData, Config, Data, Dictionary, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Group, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, type OutlinePluginProps, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RichTextMenu, Separator, UiState, type UsePuckData, UserGenerics, Viewports, blocksPlugin, createUsePuck, fieldsPlugin, legacySideBarPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { H as Field, J as FieldProps, y as DropZoneProps, m as Config, am as UserGenerics, D as Data, al as UiState, Y as OnAction, $ as Permissions, a0 as Plugin, _ as Overrides, N as FieldTransforms, a3 as PuckAction, ao as Viewports, Q as IframeConfig, R as InitialHistory, V as Metadata, a8 as ResolveDataTrigger, S as ItemSelector, i as ComponentData, a1 as PluginInternal } from './actions-Csn3gOP8.js';
 export { A as Adaptor, a as AppState, b as ArrayField, c as ArrayState, d as AsFieldProps, B as BaseData, e as BaseField, C as CacheOpts, f as ComponentConfig, g as ComponentConfigExtensions, h as ComponentConfigParams, j as ComponentDataMap, k as ComponentDataOptionalId, l as ComponentMetadata, n as ConfigParams, o as Content, p as CustomField, q as CustomFieldRender, r as DefaultComponentProps, s as DefaultComponents, t as DefaultRootFieldProps, u as DefaultRootProps, v as DefaultRootRenderProps, w as Direction, x as DragAxis, E as ExternalField, z as ExternalFieldWithAdaptor, F as ExtractConfigParams, G as ExtractField, I as FieldMetadata, K as FieldRenderFunctions, L as FieldTransformFn, M as FieldTransformFnParams, O as Fields, P as History, T as ItemWithId, U as MappedItem, W as NumberField, X as ObjectField, Z as OverrideKey, a4 as PuckComponent, a5 as PuckContext, a6 as PuckMetadata, a7 as RadioField, a9 as RichText, aa as RichtextField, ab as RootConfig, ac as RootData, ad as RootDataWithProps, ae as RootDataWithoutProps, af as SelectField, ag as Slot, ah as SlotComponent, ai as SlotField, aj as TextField, ak as TextareaField, an as Viewport, ap as WithChildren, aq as WithId, ar as WithPuckProps, as as WithSlotProps, at as overrideKeys } from './actions-Csn3gOP8.js';
+import { D as Dictionary, A as AppStore, G as GetPermissions, R as RefreshPermissions, H as HistorySlice } from './index-t7c1w81O.js';
 export { m as migrate, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-CWrsBHHe.js';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { A as AppStore, G as GetPermissions, R as RefreshPermissions, H as HistorySlice } from './index-B1b1cFug.js';
 import '@tiptap/react';
 import '@tiptap/extension-blockquote';
 import '@tiptap/extension-bold';
@@ -150,6 +150,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     };
     initialHistory?: InitialHistory;
     metadata?: Metadata;
+    dictionary?: Dictionary;
     height?: CSSProperties["height"];
     _experimentalFullScreenCanvas?: boolean;
     _experimentalVirtualization?: boolean;
@@ -276,6 +277,7 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
         hasPast: boolean;
         hasFuture: boolean;
     };
+    dictionary: Dictionary;
 };
 type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
 type UsePuckStore<UserConfig extends Config = Config> = PuckApi<UserConfig>;
@@ -297,14 +299,27 @@ declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<Use
  */
 declare function useGetPuck(): () => UsePuckStore<Config>;
 
-declare const blocksPlugin: () => Plugin;
+type BlocksPluginProps = {
+    label?: string;
+    icon?: ReactNode;
+};
+declare const blocksPlugin: (props?: BlocksPluginProps) => Plugin;
 
 declare const fieldsPlugin: (params?: {
     desktopSideBar?: "left" | "right";
+    label?: string;
+    icon?: ReactNode;
 }) => PluginInternal;
 
-declare const outlinePlugin: () => Plugin;
+type OutlinePluginProps = {
+    label?: string;
+    icon?: ReactNode;
+};
+declare const outlinePlugin: (props?: OutlinePluginProps) => Plugin;
 
-declare const legacySideBarPlugin: () => Plugin;
+declare const legacySideBarPlugin: (props?: {
+    outlineLabel?: string;
+    componentsLabel?: string;
+}) => Plugin;
 
-export { Action, ActionBar, AutoField, Button, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Group, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RichTextMenu, Separator, UiState, type UsePuckData, UserGenerics, Viewports, blocksPlugin, createUsePuck, fieldsPlugin, legacySideBarPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };
+export { Action, ActionBar, AutoField, type BlocksPluginProps, Button, ComponentData, Config, Data, Dictionary, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Group, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, type OutlinePluginProps, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RichTextMenu, Separator, UiState, type UsePuckData, UserGenerics, Viewports, blocksPlugin, createUsePuck, fieldsPlugin, legacySideBarPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };