• Home
• com.raquo
• laminar-shoelace_sjs1_3
• 0.1.0
• source code
• IconButton.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.raquo.laminar.shoelace.sl.IconButton.scala Maven / Gradle / Ivy

package com.raquo.laminar.shoelace.sl

import com.raquo.laminar.keys.{EventProp, HtmlAttr}
import com.raquo.laminar.api.L
import org.scalajs.dom

import scala.scalajs.js
import scala.scalajs.js.|
import scala.scalajs.js.annotation.JSImport

// This file is generated at compile-time by ShoelaceGenerator.scala

/**
  * Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.
  * 
  * [[https://github.com/raquo/laminar-shoelace-components/blob/master/src/main/scala/com/raquo/laminar/shoelace/sl/IconButton.scala IconButton.scala source code]]
  * 
  * [[https://shoelace.style/components/icon-button Shoelace IconButton docs]]
  */
object IconButton extends WebComponent("sl-icon-button") {

  @JSImport("@shoelace-style/shoelace/dist/components/icon-button/icon-button.js", JSImport.Namespace)
  @js.native object RawImport extends js.Object

  type Self = IconButton.type

  type Ref = IconButtonComponent with dom.HTMLElement


  // -- Events --

  /** Emitted when the icon button loses focus. */
  lazy val onBlur: EventProp[dom.Event] = eventProp("sl-blur")

  /** Emitted when the icon button gains focus. */
  lazy val onFocus: EventProp[dom.Event] = eventProp("sl-focus")


  // -- Attributes --

  /** The name of the icon to draw. Available names depend on the icon library being used. */
  lazy val name: HtmlAttr[String] = stringAttr("name")

  /** The name of a registered custom icon library. */
  lazy val library: HtmlAttr[String] = stringAttr("library")

  /**
    * An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and
    * can result in XSS attacks.
    */
  lazy val src: HtmlAttr[String] = stringAttr("src")

  /** When set, the underlying button will be rendered as an `` with this `href` instead of a ``. */
  lazy val href: HtmlAttr[String] = stringAttr("href")

  /** Tells the browser where to open the link. Only used when `href` is set. */
  lazy val target: CommonKeys.target.type = CommonKeys.target

  /** Tells the browser to download the linked file as this filename. Only used when `href` is set. */
  lazy val download: HtmlAttr[String] = stringAttr("download")

  /**
    * A description that gets read by assistive devices. For optimal accessibility, you should always include a label
    * that describes what the icon button does.
    */
  lazy val label: HtmlAttr[String] = stringAttr("label")

  /** Disables the button. */
  lazy val disabled: HtmlAttr[Boolean] = boolAttr("disabled")


  // -- Props --


  // -- Slots --

  /** This component has no slots - don't give it any children. */
  @inline def noSlots: Unit = ()


  // -- CSS Vars --


  // -- CSS Parts --

  /** For documentation only. You need to style these from a CSS stylesheet. */
  object cssParts {

    /** The component's base wrapper. */
    lazy val base: String = "base"
  }


  // -- Element type -- 

  @js.native trait IconButtonComponent extends js.Object { this: dom.HTMLElement => 

    /** The name of the icon to draw. Available names depend on the icon library being used. */
    var name: String | Unit

    /** The name of a registered custom icon library. */
    var library: String | Unit

    /**
      * An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and
      * can result in XSS attacks.
      */
    var src: String | Unit

    /** When set, the underlying button will be rendered as an `` with this `href` instead of a ``. */
    var href: String | Unit

    /** Tells the browser where to open the link. Only used when `href` is set. */
    var target: String | Unit

    /** Tells the browser to download the linked file as this filename. Only used when `href` is set. */
    var download: String | Unit

    /**
      * A description that gets read by assistive devices. For optimal accessibility, you should always include a label
      * that describes what the icon button does.
      */
    var label: String

    /** Disables the button. */
    var disabled: Boolean
  }
}