react-tinacms-contentful

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ClientMode

ClientMode: "delivery" | "preview" | "management"

ContentfulEntriesFormOptions

ContentfulEntriesFormOptions: ContentfulEntryFormOptions

ContentfulMultiClient

ContentfulMultiClient: Pick<ContentfulClient, "authenticate" | "allowedOrigins"> & {}

ContentfulUpload

ContentfulUpload: { fields: { description: string; file: { contentType: string; file: string | ArrayBuffer | any; fileName: string }; title: string } }

Type declaration

fields: { description: string; file: { contentType: string; file: string | ArrayBuffer | any; fileName: string }; title: string }
- description: string
- file: { contentType: string; file: string | ArrayBuffer | any; fileName: string }
  - contentType: string
  - file: string | ArrayBuffer | any
  - fileName: string
- title: string

Operation

Operation<Type>: Type extends "dereference" ? BaseOperation<"dereference"> & { fields: undefined } : BaseOperation<Type>

Type parameters

Type = OperationType

OperationType

OperationType: "create" | "update" | "dereference"

OptionalSpaceOptions

OptionalSpaceOptions: Partial<Omit<CreateClientParams, "accessToken" | "space" | "environment">> & { deliveryClient?: ContentfulClientApi; previewClient?: ContentfulClientApi }

Space

Space: SpaceOptions

deprecated: Renamed to SpaceOptions. This type will be removed in v1.0.0.

getEntriesOptions

getEntriesOptions<Mode>: Omit<getEntryOptions<Mode>, "query">

Type parameters

Mode: ClientMode

getEntryOptions

getEntryOptions<Mode>: { locale?: string; mode?: Mode; preview?: boolean; query?: any }

Type parameters

Mode: ClientMode

Type declaration

Optional locale?: string
Optional mode?: Mode
Optional preview?: boolean

deprecated

Use mode instead. Will be removed in 1.0.0
Optional query?: any

Variables

Const AUTH_FAILURE

AUTH_FAILURE: "contentful:auth:failure" = "contentful:auth:failure"

Const AUTH_SUCCESS

AUTH_SUCCESS: "contentful:auth:success" = "contentful:auth:success"

Const CHANGE_ENVIRONMENT

CHANGE_ENVIRONMENT: "contentful:environment:change" = "contentful:environment:change"

Const CONTENTFUL_AUTH_HOSTNAME

CONTENTFUL_AUTH_HOSTNAME: "be.contentful.com" = "be.contentful.com"

Const CONTENTFUL_AUTH_TOKEN

CONTENTFUL_AUTH_TOKEN: "TINACMS_CONTENTFUL_USER_AUTH_TOKEN" = "TINACMS_CONTENTFUL_USER_AUTH_TOKEN"

Const CREATE_ENVIRONMENT

CREATE_ENVIRONMENT: "contentful:environment:create" = "contentful:environment:create"

Const CustomPaginatorPlugin

CustomPaginatorPlugin: MediaPaginatorPlugin = ...

Const ENTRY_DELETE

ENTRY_DELETE: "contentful:entry:delete" = "contentful:entry:delete"

Const ENTRY_PUBLISH

ENTRY_PUBLISH: "contentful:entry:publish" = "contentful:entry:publish"

Const ENTRY_UPDATE

ENTRY_UPDATE: "contentful:entry:update" = "contentful:entry:update"

Const ERROR

ERROR: "contentful:error" = "contentful:error"

Const FILE_TYPES

FILE_TYPES: FileTypes

Const MediaArchiveAction

MediaArchiveAction: { action: (props: ArchiveActionProps) => Element; type: string } = ...

Type declaration

action: (props: ArchiveActionProps) => Element
- - (props: ArchiveActionProps): Element
  - Parameters
    - props: ArchiveActionProps
    Returns Element
type: string

Const MediaFilterAction

MediaFilterAction: { action: () => Element; type: string } = ...

Type declaration

action: () => Element
- - (): Element
  - Returns Element
type: string

Const MediaFilterScreenPlugin

MediaFilterScreenPlugin: ScreenPlugin = ...

Const ON_LOGIN

ON_LOGIN: "contentful:login" = "contentful:login"

Const ON_LOGOUT

ON_LOGOUT: "contentful:logout" = "contentful:logout"

Functions

Const AsyncAction

AsyncAction(__namedParameters: AsyncActionButtonProps): Element

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulEntryForm.tsx:254
Parameters
- __namedParameters: AsyncActionButtonProps
Returns Element

MediaArchiveActionButton

MediaArchiveActionButton(props: ArchiveActionProps): Element

- Defined in packages/react-tinacms-contentful/src/media/actions/archive.tsx:10
Parameters
- props: ArchiveActionProps
Returns Element

MediaFilter

MediaFilter(): Element

- Defined in packages/react-tinacms-contentful/src/media/actions/media-filter/media-filter-screen.tsx:5
Returns Element

MediaFilterActionButton

MediaFilterActionButton(): Element

- Defined in packages/react-tinacms-contentful/src/media/actions/media-filter/media-filter-action.tsx:7
Returns Element

MediaManagerFilterModal

MediaManagerFilterModal(props: MediaManagerFilterModalProps): Element

- Defined in packages/react-tinacms-contentful/src/media/actions/media-filter/media-filter-action.tsx:28
Parameters
- props: MediaManagerFilterModalProps
Returns Element

Paginator

Paginator(__namedParameters: MediaPaginatorProps): null | Element

- Defined in packages/react-tinacms-contentful/src/media/paginator.tsx:8
A custom media paginator designed to handle hundreds of pages of Contentful Assets

Parameters
- __namedParameters: MediaPaginatorProps
Returns null | Element

Const TinaContentfulProvider

TinaContentfulProvider(__namedParameters: TinaContentfulProviderProps): Element

- Defined in packages/react-tinacms-contentful/src/providers/TinacmsContentfulProvider.tsx:22
A provider for managing the Oauth authentication UI workflow for Contentful

Parameters
- __namedParameters: TinaContentfulProviderProps
Returns Element

authenticateWithContentful

authenticateWithContentful(clientId: string, redirectUrl: string, allowedOrigins: string[], authWindow?: Window): Promise<string>

- Defined in packages/tinacms-contentful/dist/Authentication/authentication.d.ts:1
Parameters
- clientId: string
- redirectUrl: string
- allowedOrigins: string[]
- Optional authWindow: Window
Returns Promise<string>

createContentfulClientForSpaces

createContentfulClientForSpaces(spaces: SpaceOptions[], options: ContentfulClientOptions): ContentfulMultiClient

- Defined in packages/tinacms-contentful/dist/ApiClient/createClientForSpaces.d.ts:5
Parameters
- spaces: SpaceOptions[]
- options: ContentfulClientOptions
Returns ContentfulMultiClient

Const createContentfulOperationsForEntries

createContentfulOperationsForEntries(initial: Entry<any>[], updated: Entry<any>[], parent?: null | Entry<any>, options?: GraphOptions): { create: BaseOperation<"create">[]; dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]; graph: OperationsGraph; update: BaseOperation<"update">[] }

- Defined in packages/tinacms-contentful/dist/ContentfulRestApi/management/operationsGraph.d.ts:59
Takes an initial and updated state of an array of entries, and computes a graph of the changes:
- nodes: the individual operations to run to update the delta
- edges: the relationships between operations, allowing different traversal paths
Parameters
- initial: Entry<any>[]
  
  The initial state of the entry
- updated: Entry<any>[]
  
  The updated state of the entry
- Optional parent: null | Entry<any>
- Optional options: GraphOptions
Returns { create: BaseOperation<"create">[]; dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]; graph: OperationsGraph; update: BaseOperation<"update">[] }

operations and the graph
- create: BaseOperation<"create">[]
- dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]
- graph: OperationsGraph
- update: BaseOperation<"update">[]

Const createContentfulOperationsForEntry

createContentfulOperationsForEntry(initial: null | Entry<any>, updated: null | Entry<any>, options?: GraphOptions): { create: BaseOperation<"create">[]; dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]; graph: OperationsGraph; update: BaseOperation<"update">[] }

- Defined in packages/tinacms-contentful/dist/ContentfulRestApi/management/operationsGraph.d.ts:38
Takes an initial and updated state of an entry, and computes a graph of the changes:
- nodes: the individual operations to run to update the delta
- edges: the relationships between operations, allowing different traversal paths
Parameters
- initial: null | Entry<any>
  
  The initial state of the entry
- updated: null | Entry<any>
  
  The updated state of the entry
- Optional options: GraphOptions
Returns { create: BaseOperation<"create">[]; dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]; graph: OperationsGraph; update: BaseOperation<"update">[] }

operations and the graph
- create: BaseOperation<"create">[]
- dereference: (Entry<unknown> & { type: "dereference" } & { fields: undefined })[]
- graph: OperationsGraph
- update: BaseOperation<"update">[]

createFieldConfigFromContentType

createFieldConfigFromContentType(contentType: ContentType): TinaField<any>[]

- Defined in packages/tinacms-contentful/dist/FormMapper/FormMapper.d.ts:9
Converts a Contentful Content Type to a TinaCMS Fields Array

Parameters
- contentType: ContentType
  
  The content type to convert
Returns TinaField<any>[]

An array of TinaCMS fields

getBearerToken

getBearerToken(window: Window, allowedOrigins?: string[]): void

- Defined in packages/tinacms-contentful/dist/Authentication/oauth.d.ts:5
Parameters
- window: Window
- Optional allowedOrigins: string[]
Returns void

getCachedBearerToken

getCachedBearerToken(): string | undefined

- Defined in packages/tinacms-contentful/dist/Authentication/oauth.d.ts:7
Returns string | undefined

onBearerToken

onBearerToken(allowedOrigins?: string[]): Promise<string>

- Defined in packages/tinacms-contentful/dist/Authentication/oauth.d.ts:4
Parameters
- Optional allowedOrigins: string[]
Returns Promise<string>

openOauthWindow

openOauthWindow(clientId: string, redirectUrl: string): Window

- Defined in packages/tinacms-contentful/dist/Authentication/oauth.d.ts:3
Parameters
- clientId: string
- redirectUrl: string
Returns Window

setCachedBearerToken

setCachedBearerToken(bearerToken: string, secure?: boolean): void

- Defined in packages/tinacms-contentful/dist/Authentication/oauth.d.ts:6
Parameters
- bearerToken: string
- Optional secure: boolean
Returns void

useContentful

useContentful(spaceId?: string): ContentfulClient

- Defined in packages/react-tinacms-contentful/src/hooks/useContentful.ts:10
Retrieves the ContentfulClient from the CMS

Parameters
- Optional spaceId: string
  
  When using multiple spaces, specify the space you need the client for (Optional)
Returns ContentfulClient

useContentfulAuthRedirect

useContentfulAuthRedirect(): void

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulAuthRedirect.ts:7
Retreives the OAuth Bearer Token from the page used as the OAuth App's callback URL

Returns void

useContentfulDelivery

useContentfulDelivery(spaceId?: string): ContentfulClientApi

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulDelivery.ts:10
Retrieves the Contentful Delivery SDK from the CMS

Parameters
- Optional spaceId: string
  
  When using multiple spaces, specify the space you need the client for (Optional)
Returns ContentfulClientApi

useContentfulEntries

useContentfulEntries<TEntryType>(query: any, options?: useContentfulEntriesOptions): [Entry<TEntryType>[], boolean, Error | undefined]

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulEntries.ts:18
Fetches an array of Contentful Entries for a given query

Type parameters
- TEntryType = any
Parameters
- query: any
  
  The query to run to fetch entries
- Optional options: useContentfulEntriesOptions
Returns [Entry<TEntryType>[], boolean, Error | undefined]

useContentfulEntriesForm

useContentfulEntriesForm<EntryShape>(entries: Entry<EntryShape>[], options: ContentfulEntriesFormOptions, watch?: Partial<WatchableFormValue>): [Entry<EntryShape>[], Form]

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulEntriesForm.tsx:26
Creates a TinaCMS Form for an array of entries

Type parameters
- EntryShape: Record<string, any> = any
Parameters
- entries: Entry<EntryShape>[]
- options: ContentfulEntriesFormOptions
- Optional watch: Partial<WatchableFormValue>
  
  The TinaCMS form values to watch for changes and update the form with
Returns [Entry<EntryShape>[], Form]

useContentfulEntry

useContentfulEntry<TEntryType>(entryId: string, options?: useContentfulEntryOptions): [Entry<TEntryType> | undefined, boolean, Error | undefined]

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulEntry.ts:20
Fetches a Contentful Entry by ID

Type parameters
- TEntryType: Entry<any, TEntryType>
Parameters
- entryId: string
- Optional options: useContentfulEntryOptions
Returns [Entry<TEntryType> | undefined, boolean, Error | undefined]

useContentfulEntryForm

useContentfulEntryForm<EntryShape>(entry: Entry<EntryShape>, options: ContentfulEntryFormOptions, watch?: Partial<WatchableFormValue>): [Entry<EntryShape>, Form, EntryStatus]

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulEntryForm.tsx:39
Creates a TinaCMS Form for a given Entry

Type parameters
- EntryShape: Record<string, any> = any
Parameters
- entry: Entry<EntryShape>
  
  The entry to edit
- options: ContentfulEntryFormOptions
- Optional watch: Partial<WatchableFormValue>
  
  The TinaCMS form values to watch for changes and update the form with
Returns [Entry<EntryShape>, Form, EntryStatus]

useContentfulManagement

useContentfulManagement(spaceId?: string): ClientAPI | undefined

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulManagement.ts:10
Retrieves the Contentful Management SDK from the CMS

Parameters
- Optional spaceId: string
  
  When using multiple spaces, specify the space you need the client for (Optional)
Returns ClientAPI | undefined

useContentfulPreview

useContentfulPreview(spaceId?: string): ContentfulClientApi

- Defined in packages/react-tinacms-contentful/src/hooks/useContentfulPreview.ts:10
Retrieves the Contentful Preview SDK from the CMS

Parameters
- Optional spaceId: string
  
  When using multiple spaces, specify the space you need the client for (Optional)
Returns ContentfulClientApi

Const useMediaFilterScreenPlugin

useMediaFilterScreenPlugin(): void

- Defined in packages/react-tinacms-contentful/src/media/actions/media-filter/media-filter-screen.tsx:19
Returns void

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ClientMode

ContentfulEntriesFormOptions

ContentfulMultiClient

ContentfulUpload

Type declaration

fields: { description: string; file: { contentType: string; file: string | ArrayBuffer | any; fileName: string }; title: string }

description: string

file: { contentType: string; file: string | ArrayBuffer | any; fileName: string }

contentType: string

file: string | ArrayBuffer | any

fileName: string

title: string

Operation

Type parameters

Type = OperationType

OperationType

OptionalSpaceOptions

Space

getEntriesOptions

Type parameters

Mode: ClientMode

getEntryOptions

Type parameters

Mode: ClientMode

Type declaration

Optional locale?: string

Optional mode?: Mode

Optional preview?: boolean

Optional query?: any

Variables

Const AUTH_FAILURE

Const AUTH_SUCCESS

Const CHANGE_ENVIRONMENT

Const CONTENTFUL_AUTH_HOSTNAME

Const CONTENTFUL_AUTH_TOKEN

Const CREATE_ENVIRONMENT

Const CustomPaginatorPlugin

Const ENTRY_DELETE

Const ENTRY_PUBLISH

Const ENTRY_UPDATE

Const ERROR

Const FILE_TYPES

Const MediaArchiveAction

Type declaration

action: (props: ArchiveActionProps) => Element

Parameters

props: ArchiveActionProps

Returns Element

type: string

Const MediaFilterAction

Type declaration

action: () => Element

Returns Element

type: string

Const MediaFilterScreenPlugin

Const ON_LOGIN

Const ON_LOGOUT

Functions

Const AsyncAction

Parameters

__namedParameters: AsyncActionButtonProps

Returns Element

MediaArchiveActionButton

Parameters

props: ArchiveActionProps

Returns Element

MediaFilter

Returns Element

MediaFilterActionButton

Returns Element

MediaManagerFilterModal

Parameters

props: MediaManagerFilterModalProps