PuckApi

PuckApi exposes Puck’s internals to enable extension and modification to Puck’s core behavior. It can be accessed by the usePuck and useGetPuck hooks.

Params

appState

The current application state for this Puck instance.

console.log(appState.data);
// { content: [], root: {}, zones: {} }

dispatch(action)

Execute an action to mutate the Puck application state.

dispatch({
  type: "setUi",
  ui: {
    leftSideBarVisible: false,
  },
});

getItemBySelector(selector)

Get an item’s ComponentData by its selector.

getItemBySelector({
  index: 0,
  zone: "Flex-123:children", // The "children" slot field in the component with id "Flex-123"
});
// { type: "HeadingBlock", props: {} }

getItemById(id)

Get an item’s ComponentData by its component id.

getItemById("HeadingBlock-123");
// { type: "HeadingBlock", props: {} }

getSelectorForId(id)

Get an item’s selector by its component id.

getSelectorForId("HeadingBlock-123");
// { index: 0, zone: "Flex-123:children" }

getPermissions(params)

Get global, component or resolved dynamic permissions.

getPermissions();
// { delete: true, edit: true }

Params

item

Specify item to retrieve the permissions for a given component instance, resolving any dynamic permissions for that component, as set by the resolvePermissions parameter.

getPermissions({
  item: { type: "HeadingBlock", props: { id: "Heading-1234" } }, // Get resolved permissions for Heading-1234
});
// { delete: false }

The getPermissions function will be redefined when after resolving dynamic permissions, so it’s generally required to wrap it in a useEffect hook:

const [myPermissions, setMyPermissions] = useState(getPermissions());
 
useEffect(() => {
  setMyPermissions(getPermissions());
}, [getPermissions]);

root

Specify root to retrieve the permissions for the root, as set by the permissions parameter.

getPermissions({ root: true });
// { delete: false }

type

Specify type to retrieve the permissions for a given component type, as set by the permissions parameter.

getPermissions({ type: "HeadingBlock" });
// { delete: false }

history

The history API provides programmatic access to the undo/redo AppState history.

history.back()

A function to move the app state back through the histories.

history.forward()

A function to move the app state forward through the histories.

history.hasPast

A boolean describing whether or not the present app state has past history items.

history.hasFuture

A boolean describing whether or not the present app state has future history items.

history.histories

An array describing the recorded history as History objects.

History params

state

The app state payload for this history entry.

id

An optional ID for this history entry.

history.index

The index of the currently selected history in history.histories

setHistories

A function to set the history state.

setHistories([]); // clears all history

setHistoryIndex

A function to set current history index.

setHistoryIndex(2);

refreshPermissions(params)

Force the permissions to refresh, running all resolvePermissions functions and skipping the cache.

resolvePermissions(); // Refresh all permissions

Params

item

Specify item to refresh the permissions for a given component instance only.

refreshPermissions({
  item: { type: "HeadingBlock", props: { id: "Heading-1234" } }, // Force refresh the resolved permissions for Heading-1234
});

root

Specify root to refresh the permissions for the root only.

refreshPermissions({ root: true });

type

Specify type to refresh the permissions for all components of a given component type.

refreshPermissions({ type: "HeadingBlock" });

selectedItem

The currently selected item, as defined by appState.ui.itemSelector.

console.log(selectedItem);
// { type: "Heading", props: {id: "my-heading"} }