Up – OCaml package documentation » bonsai_web_components index » Library bonsai_web_components.byo_icon » Byo_icon » Expert

Module `Byo_icon.Expert`

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.

val create : 
  name:string ->
  svg_path:string ->
  view_box_dimension:int ->
  color_property:[ `Fill | `Stroke ] ->
  t

Create a Byo_icon.

val svg_string : 
  ?size:[< Css_gen.Length.t ] ->
  ?color:[< Css_gen.Color.t ] ->
  ?stroke_width:[< Css_gen.Length.t ] ->
  icon:t ->
  unit ->
  string

Render a svg as a string. This can be useful for favicons or including inside css, e.g. as a custom background.