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

Go to download
package com.raquo.laminar.shoelace.sl

import com.raquo.laminar.keys.{HtmlProp, 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

/**
  * Generates a [QR code](https://www.qrcode.com/) and renders it using the [Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API).
  * 
  * [[https://github.com/raquo/laminar-shoelace-components/blob/master/src/main/scala/com/raquo/laminar/shoelace/sl/QrCode.scala QrCode.scala source code]]
  * 
  * [[https://shoelace.style/components/qr-code Shoelace QrCode docs]]
  */
object QrCode extends WebComponent("sl-qr-code") {

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

  type Self = QrCode.type

  type Ref = QrCodeComponent with dom.HTMLElement


  // -- Events --


  // -- Attributes --

  /** The QR code's value. */
  lazy val defaultValue: HtmlAttr[String] = stringAttr("value")

  /** The label for assistive devices to announce. If unspecified, the value will be used instead. */
  lazy val label: HtmlAttr[String] = stringAttr("label")

  /** The size of the QR code, in pixels. */
  lazy val size: HtmlAttr[Int] = intAttr("size")

  /** The fill color. This can be any valid CSS color, but not a CSS custom property. */
  lazy val fill: HtmlAttr[String] = stringAttr("fill")

  /** The background color. This can be any valid CSS color or `transparent`. It cannot be a CSS custom property. */
  lazy val background: HtmlAttr[String] = stringAttr("background")

  /** The edge radius of each module. Must be between 0 and 0.5. */
  lazy val radius: HtmlAttr[Int] = intAttr("radius")

  /** The level of error correction to use. [Learn more](https://www.qrcode.com/en/about/error_correction.html) */
  lazy val errorCorrection: HtmlAttr[String] = stringAttr("error-correction")


  // -- Props --

  /** The QR code's value. */
  lazy val value: HtmlProp[String, _] = L.value


  // -- 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 QrCodeComponent extends js.Object { this: dom.HTMLElement => 

    /** The QR code's value. */
    var value: String

    /** The label for assistive devices to announce. If unspecified, the value will be used instead. */
    var label: String

    /** The size of the QR code, in pixels. */
    var size: Int

    /** The fill color. This can be any valid CSS color, but not a CSS custom property. */
    var fill: String

    /** The background color. This can be any valid CSS color or `transparent`. It cannot be a CSS custom property. */
    var background: String

    /** The edge radius of each module. Must be between 0 and 0.5. */
    var radius: Int

    /** The level of error correction to use. [Learn more](https://www.qrcode.com/en/about/error_correction.html) */
    var errorCorrection: String
  }
}