Class GirafeResizableElementAbstract

Protected OptionaldisplayStyle

Protected OptionalfeedbackTemplateHtml

Protectedrendered

Protectedshadow

Protected AbstractstyleUrls

Protectedtemplate

Protected AbstracttemplateUrl

Protectedcontext

• get context(): IGirafeContext

  Returns IGirafeContext

ProtectedisFullscreenComponent

• get isFullscreenComponent(): boolean

  Whether this Component must stay visible when the App is in Fullscreen Mode. Controlled by the "fullscreen" attribute (default: false).

  Returns boolean

Protectedstate

• get state(): State

  Returns State

ProtectedcanExecute

• canExecute(eventName: GgUserInteractionEvent): boolean

  Parameters

  • eventName: GgUserInteractionEvent

  Returns boolean

ProtectedconnectedCallback

• connectedCallback(): void

  Returns void

ProtecteddisconnectedCallback

• disconnectedCallback(): void

  When the component is disconnected from the DOM all the callbacks will be unregistered

  Returns void

ProtectedgetById

• getById<T = HTMLElement>(id: string): T

  Type Parameters

  • T = HTMLElement

  Parameters

  • id: string

  Returns T

ProtectedgetChildElement

• getChildElement<T = HTMLElement>(selector: string): T

  Type Parameters

  • T = HTMLElement

  Parameters

  • selector: string

  Returns T

ProtectedgetInheritedContext

• getInheritedContext(): IGirafeContext

  Returns IGirafeContext

ProtectedgetParentOfType

• getParentOfType(
      parentNodeName: string,
      elem: Node | null,
      initialElem?: Node | null,
  ): Node | null

  Parameters

  • parentNodeName: string
  • elem: Node | null
  • initialElem: Node | null = elem

  Returns Node | null

ProtectedgirafeTranslate

• girafeTranslate(): void

  Returns void

Protectedhide

• hide(): void

  Hide the component (display: none).

  Returns void

ProtectedhtmlUnsafe

• htmlUnsafe(str: string): Hole

  Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('

  ') will return an html div object.

  Parameters

  • str: string

  Returns Hole

ProtectedisNullOrUndefined

• isNullOrUndefined(val: unknown): boolean

  NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/

  Parameters

  • val: unknown

  Returns boolean

ProtectedisNullOrUndefinedOrBlank

• isNullOrUndefinedOrBlank(val: unknown): boolean

  Parameters

  • val: unknown

  Returns boolean

ProtectedrefreshRender

• refreshRender(): void

  Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.

  Returns void

ProtectedregisterInteractionListener

• registerInteractionListener(
      eventName: GgUserInteractionEvent,
      isExclusive: boolean,
  ): boolean

  Parameters

  • eventName: GgUserInteractionEvent
  • isExclusive: boolean

  Returns boolean

ProtectedrenderEmpty

• renderEmpty(): void

  Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.

  Returns void

Protectedshow

• show(): void

  Show the component (display: block).

  Returns void

ProtectedsimulateClick

• simulateClick(e: KeyboardEvent): void

  In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element

  Parameters

  • e: KeyboardEvent

  Returns void

Protectedsubscribe

• subscribe(path: string, callback: Callback): Callback

  Subscribes with to the state changes made on

  Parameters

  • path: string
  • callback: Callback

  Returns Callback

• subscribe(path: RegExp, callback: Callback): Callback

  Subscribes with to the state changes made on

  Parameters

  • path: RegExp
  • callback: Callback

  Returns Callback

ProtectedunregisterInteractionListeners

• unregisterInteractionListeners(
      eventNames?: GgUserInteractionEvent | GgUserInteractionEvent[],
  ): void

  Parameters

  • OptionaleventNames: GgUserInteractionEvent | GgUserInteractionEvent[]

  Returns void

Protectedunsubscribe

• unsubscribe(callback: Callback): void

  Parameters

  • callback: Callback

    Unsubscribe all callbacks

  Returns void

• unsubscribe(callbacks: Callback[]): void

  Parameters

  • callbacks: Callback[]

  Returns void