gradum-kit - v0.1.0
    Preparing search index...

    Function $

    • $<
          Tag extends
              | "symbol"
              | "animate"
              | "animateMotion"
              | "animateTransform"
              | "circle"
              | "clipPath"
              | "defs"
              | "desc"
              | "ellipse"
              | "feBlend"
              | "feColorMatrix"
              | "feComponentTransfer"
              | "feComposite"
              | "feConvolveMatrix"
              | "feDiffuseLighting"
              | "feDisplacementMap"
              | "feDistantLight"
              | "feDropShadow"
              | "feFlood"
              | "feFuncA"
              | "feFuncB"
              | "feFuncG"
              | "feFuncR"
              | "feGaussianBlur"
              | "feImage"
              | "feMerge"
              | "feMergeNode"
              | "feMorphology"
              | "feOffset"
              | "fePointLight"
              | "feSpecularLighting"
              | "feSpotLight"
              | "feTile"
              | "feTurbulence"
              | "filter"
              | "foreignObject"
              | "g"
              | "image"
              | "line"
              | "linearGradient"
              | "marker"
              | "mask"
              | "metadata"
              | "mpath"
              | "path"
              | "pattern"
              | "polygon"
              | "polyline"
              | "radialGradient"
              | "rect"
              | "set"
              | "stop"
              | "svg"
              | "switch"
              | "text"
              | "textPath"
              | "tspan"
              | "use"
              | "view"
              | (keyof HTMLElementTagNameMap)
              | (keyof MathMLElementTagNameMap)
              | (keyof GradumElementTagNameMap) = "div",
      >(
          tag?: Tag,
      ): Gradum<ValidElement<Tag>>
      Function

      $

      Type Parameters

      • Tag extends
            | "symbol"
            | "animate"
            | "animateMotion"
            | "animateTransform"
            | "circle"
            | "clipPath"
            | "defs"
            | "desc"
            | "ellipse"
            | "feBlend"
            | "feColorMatrix"
            | "feComponentTransfer"
            | "feComposite"
            | "feConvolveMatrix"
            | "feDiffuseLighting"
            | "feDisplacementMap"
            | "feDistantLight"
            | "feDropShadow"
            | "feFlood"
            | "feFuncA"
            | "feFuncB"
            | "feFuncG"
            | "feFuncR"
            | "feGaussianBlur"
            | "feImage"
            | "feMerge"
            | "feMergeNode"
            | "feMorphology"
            | "feOffset"
            | "fePointLight"
            | "feSpecularLighting"
            | "feSpotLight"
            | "feTile"
            | "feTurbulence"
            | "filter"
            | "foreignObject"
            | "g"
            | "image"
            | "line"
            | "linearGradient"
            | "marker"
            | "mask"
            | "metadata"
            | "mpath"
            | "path"
            | "pattern"
            | "polygon"
            | "polyline"
            | "radialGradient"
            | "rect"
            | "set"
            | "stop"
            | "svg"
            | "switch"
            | "text"
            | "textPath"
            | "tspan"
            | "use"
            | "view"
            | (keyof HTMLElementTagNameMap)
            | (keyof MathMLElementTagNameMap)
            | (keyof GradumElementTagNameMap) = "div"

        The HTML tag of the element to instantiate.

      Parameters

      • Optionaltag: Tag

        The HTML tag of the element to instantiate. If not defined, the tag will be set to "div".

      Returns Gradum<ValidElement<Tag>>

      The instantiated, wrapped, and proxied element.

      All-in-one selector function that instantiates an element with the given tag and returns it wrapped in a proxied selector that augments it with useful functions for manipulating it. You can alternatively use gradum(), gr(), or g() for the same behavior.

    • $<Type extends object = Node>(object: Type, raw?: boolean): Gradum<Type>
      Function

      $

      Type Parameters

      • Type extends object = Node

        The type of the object to wrap.

      Parameters

      • object: Type

        The object to wrap.

      • Optionalraw: boolean

        If set to true, the selector will operate directly on the provided object, even if it contains an inner element field. Useful when you want to set properties on a proxied wrapper itself rather than its underlying DOM element.

      Returns Gradum<Type>

      The wrapped, proxied object.

      All-in-one selector function that wraps the given object in a proxied selector that augments it with useful functions for manipulating it. You can alternatively use gradum(), gr(), or g() for the same behavior.

    • $(tag: string): Gradum<Element>
      Function

      $

      Parameters

      • tag: string

        The HTML tag of the element to instantiate. If not defined, the tag will be set to "div".

      Returns Gradum<Element>

      The instantiated, wrapped, and proxied element.

      All-in-one selector function that instantiates an element with the given tag (if valid) and returns it wrapped in a proxied selector that augments it with useful functions for manipulating it. You can alternatively use gradum(), gr(), or g() for the same behavior.

    Settings
    Member Visibility