Class ShareComponent

activeTooltips

Optionalbutton

callbacks

OptionalcloseButton

componentManager

configManager

OptionaldisplayStyle

Optionaldiv

Optionalheader

name

pos1

pos2

pos3

pos4

rendered

shadow

stateManager

styleUrl

template

OptionaltimeoutId

host

• get host(): HTMLElement

  Returns HTMLElement

state

• get state(): State

  Returns State

activateTooltips

• activateTooltips(
      arrow: boolean,
      delay: [number, number],
      defaultPlacement: string,
  ): void

  Parameters

  • arrow: boolean
  • delay: [number, number]
  • defaultPlacement: string

  Returns void

closeDragElement

• closeDragElement(): void

  Returns void

deserialize

• deserialize(_serializedElement: unknown): void

  Deserialize an element and set the current element state to the deserialized one

  Parameters

  • _serializedElement: unknown

    The element serialization as returned by the serialize method

  Returns void

disconnectedCallback

• disconnectedCallback(): void

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

  Returns void

dragMouseDown

• dragMouseDown(_this: GirafeDraggableElement, e: MouseEvent): void

  Parameters

  • _this: GirafeDraggableElement
  • e: MouseEvent

  Returns void

elementDrag

• elementDrag(_this: GirafeDraggableElement, e: MouseEvent): void

  Parameters

  • _this: GirafeDraggableElement
  • e: MouseEvent

  Returns void

getBodyHeight

• getBodyHeight(): number

  Returns number

getBodyWidth

• getBodyWidth(): number

  Returns number

getById

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

  Type Parameters

  • T = HTMLElement

  Parameters

  • id: string

  Returns T

getParentOfType

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

  Parameters

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

  Returns null | Node

girafeTranslate

• girafeTranslate(): void

  Returns void

hide

• hide(): void

  Hide the component (display: none).

  Returns void

htmlUnsafe

• 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

isNullOrUndefined

• 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

isNullOrUndefinedOrBlank

• isNullOrUndefinedOrBlank(val: unknown): boolean

  Parameters

  • val: unknown

  Returns boolean

loadConfig

• loadConfig(): Promise<void>

  Returns Promise<void>

makeDraggable

• makeDraggable(): void

  Returns void

refreshRender

• 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

renderEmpty

• renderEmpty(): void

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

  Returns void

resize

• resize(_this: GirafeDraggableElement): void

  Parameters

  • _this: GirafeDraggableElement

  Returns void

serialize

• serialize(): {}

  Returns the serialization of the current element. This method should be overwritten by child classes

  Returns {}

  An object describing the current element serialized

show

• show(): void

  Show the component (display: block).

  Returns void

simulateClick

• 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

subscribe

• 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

unsubscribe

• unsubscribe(callback: Callback): void

  Parameters

  • callback: Callback

    Unsubscribe all callbacks

  Returns void
• unsubscribe(callbacks: Callback[]): void

  Parameters

  • callbacks: Callback[]

  Returns void