Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TinaCMS

Hierarchy

  • CMSBase
    • TinaCMS

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new TinaCMS(__namedParameters?: TinaCMSConfig): TinaCMS

  • Parameters

    • Optional __namedParameters: TinaCMSConfig

    Returns TinaCMS

Properties

Optional _alerts

_alerts: Alerts

api

api: { contentful: ContentfulClient }

Type declaration

disable

disable: () => void

Disable the CMS so content can no longer be edited.

Type declaration

    • (): void

    • Returns void

enable

enable: () => void

Enable the CMS so content can be edited.

Type declaration

    • (): void

    • Returns void

events

events: EventBus

media

media: MediaManager

plugins

plugins: PluginTypeManager

An object for managing CMSs plugins.

[[Plugin|Plugins]] are used to extend or modify the CMSs feature set.

Optional sidebar

sidebar: SidebarState

toggle

toggle: () => void

Toggles the enabled/disabled state of the CMS .

Type declaration

    • (): void

    • Returns void

Optional toolbar

toolbar: ToolbarState

Static DISABLED

DISABLED: { type: string }

Type declaration

  • type: string

Static ENABLED

ENABLED: { type: string }

Type declaration

  • type: string

Accessors

alerts

  • get alerts(): Alerts

  • Returns Alerts

disabled

  • get disabled(): boolean

  • When true the CMS is disabled and content cannot be edited.

    Returns boolean

enabled

  • get enabled(): boolean

  • When true the CMS is enabled and content can be edited.

    Returns boolean

fields

  • get fields(): PluginType<FieldPlugin>

  • Returns PluginType<FieldPlugin>

forms

  • get forms(): PluginType<Form<any, AnyField>>

  • Returns PluginType<Form<any, AnyField>>

screens

  • get screens(): PluginType<ScreenPlugin<{}>>

  • Returns PluginType<ScreenPlugin<{}>>

Methods

registerApi

  • registerApi(name: string, api: any): void

  • Parameters

    • name: string
    • api: any

    Returns void

Generated using TypeDoc