@umbraco-cms/backoffice
    Preparing search index...

    Class UmbIconRegistry

    UmbIconRegistry

    • Icon Registry. Provides icons from the icon manifest. Icons are loaded on demand. All icons are prefixed with 'icon-'

    Hierarchy

    • UUIIconRegistry
      • UmbIconRegistry
    Index

    Constructors

    constructor

    Methods

    acceptIcon appendIcons attach defineIcon detach getIcon getIconNames provideIcon setIcons

    Constructors

    Methods

    • Attach an element to provide this registry. Use detach when disconnected.

      Parameters

      • element: EventTarget

        the element of which to provide this icon-set.

      Returns void

    • Define a icon to be served by this registry.

      Parameters

      • iconName: string

        the name to use for this icon.

      • svgString: string

        the svg source for this icon.

      Returns void

    • Detach an element from providing this registry.

      Parameters

      • element: EventTarget

        the element of which to stop providing this icon-set.

      Returns void

    • Retrieve the SVG source of an icon, Returns ´null´ if the name does not exist.

      Parameters

      • iconName: string

        the name of the icon to retrieve.

      Returns Promise<string> | null

    • Returns string[]

    • Declare that this registry will be providing a icon for this name

      Parameters

      • iconName: string

        the name of the icon to be provided.

      Returns UUIIconHost

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods