Byo_icon (bonsai_web_components.bonsai_web_components.byo_icon.Byo

type t

A Byo_icon is an abstract wrapper around an svg icon. It's designed so that third-party icon sets such as Lucide, Feather, and Codicons can be imported to our ecosystem using the same underlying representation. Additionally, it allows us to create our own internal icon sets that are represented the same way.

val view : 
  ?size:[< Css_gen.Length.t ] ->
  ?color:[< Css_gen.Color.t ] ->
  ?stroke_width:[< Css_gen.Length.t ] ->
  ?attrs:Byo_bonsai_prelude.Attr.t list ->
  icon:t ->
  unit ->
  Byo_bonsai_prelude.Node.t

Render a given Byo_icon.t as a Node.t.

In Node_test and Node_jsdom_test a test node will be rendered instead of the svg.

val name : t -> string

Get the icon's name.

module Expert : sig ... end

Functions in Expert can produce unsafe code due to the conversion of strings to Vdom. Use with caution, and reach out to #discuss-webdev if unsure.

module For_testing : sig ... end