aqrln / phosphor-leptos

Phosphor icons for leptos

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

phosphor-leptos

Phosphor is a flexible icon family for interfaces, diagrams, presentations — whatever, really. More icons at phosphoricons.com.

Installation

phosphor-leptos = "0.1"

or

cargo add phosphor-leptos

Usage

use leptos::*;
use phosphor_leptos::{IconWeight, Horse, Heart, Cube};
#[component]
fn MyComponent() -> impl IntoView {
    view! {
        <Horse />
        <Heart color="#AE2983" weight=IconWeight::Fill size="32px" />
        <Cube color="teal" weight=IconWeight::Duotone />
    }
}

Props

All of the props are MaybeSignal's so they can be static or reactive.

  • color?: string – Icon stroke/fill color. Can be any CSS color string, including hex, rgb, rgba, hsl, hsla, named colors, or the special currentColor variable.
  • size?: number | string – Icon height & width. As with standard React elements, this can be a number, or a string with units in px, %, em, rem, pt, cm, mm, in.
  • weight?: IconWeight – Icon weight/style. Can also be used, for example, to "toggle" an icon's state: a rating component could use Stars with IconWeight::Regular to denote an empty star, and IconWeight::Fill to denote a filled star.
  • mirrored?: boolean – Flip the icon horizontally. Can be useful in RTL languages where normal icon orientation is not appropriate.

License

MIT © Phosphor Icons

Knowledge

About

Phosphor icons for leptos

License:MIT License


Languages

Language:Rust 100.0%