SDK: Types Library

📦 @dotcms/types on npm 🛠️ View source on GitHub

Installation#

---

npm install @dotcms/types@next --save-dev

Overview#

---

This package contains TypeScript type definitions for the dotCMS ecosystem. Use it to enable type safety and an enhanced developer experience when working with dotCMS APIs and structured content.

Commonly Used Types#

---

import {
  DotCMSPageAsset,
  DotCMSPageResponse,
  UVEEventType,
  DotCMSInlineEditingPayload
} from '@dotcms/types';

Type Hierarchy (Jump to Definitions)#

---

Page Types#

• DotCMSPageAsset

  • DotCMSPage
  • DotCMSPageAssetContainer
  • DotCMSSite
  • DotCMSTemplate
  • DotCMSViewAs
  • DotCMSVanityUrl
  • DotCMSURLContentMap
  • DotCMSLayout
  • DotCMSPageContainerContentlets
  • DotCMSPageResponse
  • DotCMSComposedPageAsset
  • DotCMSComposedContent
  • DotCMSComposedPageResponse
  • DotCMSClientPageGetResponse

Block Editor Types#

• BlockEditorContent

  • BlockEditorNode
  • BlockEditorMark

Editor & UVE Types#

• UVEState

  • UVE_MODE

• UVEEventHandler

• UVEEventSubscriber

  • UVEEventSubscription
  • UVEUnsubscribeFunction

• UVEEventType

  • UVEEventPayloadMap

• DotCMSPageRendererMode

• DotCMSUVEAction

Events#

• DotCMSInlineEditingPayload

  • DotCMSInlineEditingType

Client Request Types#

• DotCMSPageRequestParams

  • DotCMSGraphQLParams
  • RequestOptions
  • DotCMSClientConfig
  • DotCMSNavigationRequestParams

About#

---

This package is maintained as part of the dotCMS core repository.

Keywords#

• dotcms
• typescript
• types
• cms
• content-management-system