openpencil/packages/docs/programmable/sdk/api/composables/use-page-list.md
2026-03-24 23:24:08 +03:00

710 B

title description
usePageList Read pages and drive page switching, creation, deletion, and renaming.

usePageList

usePageList() is the page-management composable behind page list UIs.

It exposes:

  • pages
  • currentPageId
  • switchPage
  • addPage
  • deletePage
  • renamePage

Usage

import { usePageList } from '@open-pencil/vue'

const pageList = usePageList()

Basic example

const { pages, currentPageId, switchPage, addPage } = usePageList()

Practical examples

Switch pages

switchPage(pageId)

Create a new page

addPage()