lucuma.react.primereact.MessageItem.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lucuma-react-prime-react_sjs1_3 Show documentation
lucuma-react-prime-react
The newest version!
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause

package lucuma.react.primereact

import cats.Eq
import cats.derived.*
import japgolly.scalajs.react.*
import japgolly.scalajs.react.facade.React.Node
import japgolly.scalajs.react.vdom.html_<^.*
import lucuma.react.common.*

import scalajs.js

// used by Messages and Toasts
// Note: This object is called `Message` by primereact. However, primereact has 2 things named
// `Message`. This one, which is a plain JS object, and another which is a control. To avoid
// name conflicts and confusion, I renamed this one.
@js.native
trait MessageItem extends js.Object {
  var id: js.UndefOr[String]               = js.native
  var severity: js.UndefOr[String]         = js.native
  var summary: js.UndefOr[String]          = js.native
  var detail: js.UndefOr[String]           = js.native
  var content: js.UndefOr[Node]            = js.native
  var className: js.UndefOr[String]        = js.native
  var contentClassName: js.UndefOr[String] = js.native
  var closable: js.UndefOr[Boolean]        = js.native
  var sticky: js.UndefOr[Boolean]          = js.native
  var life: js.UndefOr[Int]                = js.native
  var icon: js.UndefOr[Node]               = js.native
}

object MessageItem {
  def apply(
    id:           js.UndefOr[String] = js.undefined,
    severity:     Message.Severity = Message.Severity.Info, // Without a value is mostly transparent.
    summary:      js.UndefOr[String] = js.undefined,        // for messages, use only one of summary or detail
    detail:       js.UndefOr[String] = js.undefined,
    content:      js.UndefOr[VdomNode] = js.undefined,      // instead of summary and details
    clazz:        js.UndefOr[Css] = js.undefined,
    contentClass: js.UndefOr[Css] = js.undefined,
    closable:     js.UndefOr[Boolean] = js.undefined,       // default: true
    sticky:       js.UndefOr[Boolean] = js.undefined,       // default: false?
    life:         js.UndefOr[Int] = js.undefined,           // in milliseconds. default: 3000
    icon:         js.UndefOr[Icon] = js.undefined           // only works for Messages, not Toast
  ): MessageItem = {
    val m = (new js.Object).asInstanceOf[MessageItem]
    id.foreach(v => m.id = v)
    m.severity = severity.value.asInstanceOf[String]
    summary.foreach(v => m.summary = v)
    detail.foreach(v => m.detail = v)
    content.foreach(v => m.content = v.rawNode)
    clazz.foreach(v => m.className = v.htmlClass)
    contentClass.foreach(v => m.contentClassName = v.htmlClass)
    closable.foreach(v => m.closable = v)
    sticky.foreach(v => m.sticky = v)
    life.foreach(v => m.life = v)
    icon.foreach(v => m.icon = v.toPrimeWithClass(PrimeStyles.MessageIcon))
    m
  }

  enum Severity(val value: String) derives Eq:
    case Error   extends Severity("error")
    case Info    extends Severity("info")
    case Success extends Severity("success")
    case Warn    extends Severity("warn")
}