platform-bible-react
    Preparing search index...

    Interface CommentEditorProps

    Interface containing the types of the properties that are passed to the CommentEditor

    interface CommentEditorProps {
        assignableUsers: string[];
        initialAssignedUser?: string;
        localizedStrings: CommentEditorLocalizedStrings;
        onClose: () => void;
        onSave: (contents: string, assignedUser?: string) => void;
    }
    Index

    Properties

    assignableUsers initialAssignedUser? localizedStrings onClose onSave

    Properties

    assignableUsers: string[]

    List of users that can be assigned to the new comment thread

    initialAssignedUser?: string

    The user to pre-select in the "Assign to" dropdown when the editor opens. Used to persist the last chosen assignee across consecutive comment creations within a session.

    localizedStrings: CommentEditorLocalizedStrings

    Localized strings to be passed to the comment editor component

    onClose: () => void

    External function to handle closing the comment editor. Gets called when the editor is closed without saving changes

    onSave: (contents: string, assignedUser?: string) => void

    External function to handle saving the new comment

    Type declaration

      • (contents: string, assignedUser?: string): void

      • Parameters

        • contents: string

          HTML content of the comment

        • OptionalassignedUser: string

          Optional user to assign the comment to

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties