Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentBadgePropsBeta

    interface DocumentBadgeProps {
        draft: SanityDocument;
        id: string;
        liveEdit: boolean;
        liveEditSchemaType: boolean;
        published: SanityDocument;
        ready: boolean;
        release: string;
        transactionSyncLock: TransactionSyncLockState;
        type: string;
        version: SanityDocument;
    }

    Hierarchy (View Summary)

    Index

    Properties

    draft id liveEdit liveEditSchemaType published ready release transactionSyncLock type version

    Properties

    draft: SanityDocument
    id: string
    liveEdit: boolean

    Whether live edit is enabled. This may be true for various reasons:

    • The schema type has live edit enabled.
    • A version of the document is checked out.
    liveEditSchemaType: boolean

    Whether the schema type has live edit enabled.

    published: SanityDocument
    ready: boolean
    release: string

    When editing a version, the name of the release the document belongs to.

    transactionSyncLock: TransactionSyncLockState
    type: string
    version: SanityDocument

    Settings

    Member Visibility

    On This Page

    Properties