RTDEditElement | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Class RTDEditElement

    Base class for customElements that need to act as WebHare (Publisher) form elements

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __didPlaceholderWarning? [rfSymbol]? node onInsertVideo? propTodd? propWhCleanupFunction? propWhFormCurrentEnabled? propWhFormCurrentRequired? propWhFormCurrentVisible? propWhFormhandler? propWhFormInitialRequired? propWhFormlineCurrentVisible? propWhFormSavedEnabled? propWhFormSavedHidden? propWhFormSavedRequired? propWhNodeCurrentEnabled? propWhNodeCurrentHidden? propWhNodeCurrentRequired? propWhValidationSuggestion? rte whFormsApiChecker? whUseFormGetValue? whValidationPolyfilled? formAssociated observedAttributes

    Accessors

    disabled name required value

    Methods

    _updateEnabledStatus attributeChangedCallback connectedCallback executeAction insertVideoByURL refreshState getForNode

    Constructors

    Properties

    Optional__didPlaceholderWarning

    __didPlaceholderWarning?: boolean
    "[rfSymbol]"?: FormFieldAPI
    node: this
    onInsertVideo?: (node: HTMLElement) => void
    propTodd?: ToddCompBase<ComponentStandardAttributes>
    propWhCleanupFunction?: () => void
    propWhFormCurrentEnabled?: boolean
    propWhFormCurrentRequired?: boolean
    propWhFormCurrentVisible?: boolean
    propWhFormhandler?: FormBase<object>

    Use getFormHandler or getFormData from @webhare/forms to access the form's API

    propWhFormInitialRequired?: boolean
    propWhFormlineCurrentVisible?: boolean
    propWhFormSavedEnabled?: boolean
    propWhFormSavedHidden?: boolean
    propWhFormSavedRequired?: boolean
    propWhNodeCurrentEnabled?: boolean
    propWhNodeCurrentHidden?: boolean
    propWhNodeCurrentRequired?: boolean
    propWhValidationSuggestion?: null | FormFrontendMessage
    rte: null | FreeEditor | StructuredEditor = null
    whFormsApiChecker?: () => void | Promise<void>
    whUseFormGetValue?: boolean
    whValidationPolyfilled?: boolean
    formAssociated: boolean = true
    observedAttributes: string[] = ...

    Accessors

    • set disabled(disable: boolean): void

      Parameters

      • disable: boolean

      Returns void

    • get name(): string

      Returns string

    • set name(newname: string): void

      Parameters

      • newname: string

      Returns void

    • get required(): boolean

      Returns boolean

    • set required(required: boolean): void

      Parameters

      • required: boolean

      Returns void

    • get value(): string

      Returns string

    • set value(newvalue: string): void

      Parameters

      • newvalue: string

      Returns void

    Methods

    _updateEnabledStatus

    • _updateEnabledStatus(nowenabled: boolean): void

      Parameters

      • nowenabled: boolean

      Returns void

    • Parameters

      • name: string
      • oldValue: unknown
      • newValue: unknown

      Returns void

    • Returns Promise<void>

    • Parameters

      • evt: CustomEvent<{ action: string }>

      Returns Promise<void>

    • Parameters

      • url: string

      Returns Promise<
          | { message: string; success: boolean }
          | { message?: undefined; success: boolean },
      >

    • Invoked whenever disabled/required states change

      Returns void

    • Parameters

      • node: HTMLElement

      Returns null | RTDField

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods