ngeo
    Preparing search index...

    Class ToolButtonDefault

    Default implementation of the application tools icon.

    Example with an icon classes:

       <gmf-tool-button slot="tool-button" iconClasses="fa-solid fa-print" panelName="my-panel"></gmf-tool-button>

    Example with a slot:

       <gmf-tool-button slot="tool-button" panelName="my-panel">
         <span>
           <i class="fa-solid fa-arrow-pointer"></i>
         </span>
       </gmf-tool-button>

    Hierarchy (View Summary)

    Index

    Other

    constructor iconClasses panelName title bootstrapStyle bootstrapVarStyle commonStyle fontawesomeStyle resetStyle mozRequestFullScreen mozRequestFullScreenWithKeys msRequestFullscreen webkitRequestFullscreen

    lifecycle

    connectedCallback disconnectedCallback

    rendering

    render

    styles

    styles

    updates

    firstUpdated

    Other

    iconClasses: string
    panelName: string
    title: string

    The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

    MDN Reference

    bootstrapStyle: CSSResult = cssBootstrap
    bootstrapVarStyle: CSSResult = ...
    commonStyle: CSSResult = ...
    fontawesomeStyle: CSSResult = cssFontawesome
    resetStyle: CSSResult = cssReset

    lifecycle

    • Invoked when the component is added to the document's DOM.

      In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

      connectedCallback() {
        super.connectedCallback();
        addEventListener('keydown', this._handleKeydown);
      }

      Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

      Returns void

    • Invoked when the component is removed from the document's DOM.

      This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

      disconnectedCallback() {
        super.disconnectedCallback();
        window.removeEventListener('keydown', this._handleKeydown);
      }

      An element may be re-connected after being disconnected.

      Returns void

    rendering

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns TemplateResult

    styles

    styles: CSSResult[] = ...

    Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

    Note on Content Security Policy:

    Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

    To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

    <script>
      // Generated and unique per request:
      window.litNonce = 'a1b2c3d4';
    </script>

    updates

    • Invoked when the element is first updated. Implement to perform one time work on the element after update.

      firstUpdated() {
        this.renderRoot.getElementById('my-text-area').focus();
      }

      Setting properties inside this method will trigger the element to update again after this update cycle completes.

      Returns void

    Settings

    Member Visibility

    On This Page

    Other
    lifecycle
    rendering
    styles
    updates