phosphor-vue
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.2 • Public • Published

    phosphor-vue

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

    For Vue 3 support, check out the vue3 branch.

    NPM JavaScript Style Guide Travis

    GitHub stars GitHub forks GitHub watchers Follow on GitHub

    Installation

    yarn add phosphor-vue

    or

    npm install --save phosphor-vue

    Usage

    <template>
      <div>
        <ph-horse />
        <ph-heart :size="32" color="hotpink" weight="fill" />
        <ph-cube />
      </div>
    </template>
    
    <script>
      import { PhHorse, PhHeart, PhCube } from "phosphor-vue";
      export default {
        name: "App",
        components: {
          PhHorse,
          PhHeart,
          PhCube
        }
      };
    </script>

    Props

    Icon components accept all attributes that you can pass to a normal SVG element, including inline height/width, x/y, opacity, plus @click and other v-on handlers. The main way of styling them will usually be with the following props:

    • 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?: "thin" | "light" | "regular" | "bold" | "fill" | "duotone" – Icon weight/style. Can be used, for example, to "toggle" an icon's state: a rating component could use Stars with weight="regular" to denote an empty star, and weight="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.

    Composition

    Phosphor takes advantage of Vue's provide/inject options to make applying a default style to all icons simple. Create a provide object or function at the root of the app (or anywhere above the icons in the tree) that returns a configuration object with props to be applied by default to all icons below it in the tree:

    <template>
      <div>
        <ph-horse /> {/* I'm lime-green, 32px, and bold! */} 
        <ph-heart /> {/* Me too! */} 
        <ph-cube />  {/* Me three :) */}
      </div>
    </template>
    
    <script>
      import { PhHorse, PhHeart, PhCube } from "phosphor-vue";
      export default {
        name: "App",
        components: {
          PhHorse,
          PhHeart,
          PhCube
        },
        provide: {
          color: "limegreen",
          size: 32,
          weight: "bold",
          mirrored: false
        }
      };
    </script>

    You may create multiple providers for styling icons differently in separate regions of an application; icons use the nearest provider above them to determine their style.

    Note: The color, size, weight, and mirrored properties are all optional props when creating a context, but default to "currentColor", "1em", "regular" and false. Also be aware that when using this API, per Vue:

    The provide and inject bindings are NOT reactive. This is intentional. However, if you pass down an observed object, properties on that object do remain reactive.

    Slots

    Components have a <slot> for arbitrary SVG elements, so long as they are valid children of the <svg> element. This can be used to modify an icon with background layers or shapes, filters, animations and more. The slotted children will be placed below the normal icon contents.

    The following will cause the Cube icon to rotate and pulse:

    <template>
      <ph-cube color="darkorchid" weight="duotone">
        <animate
          attributeName="opacity"
          values="0;1;0"
          dur="4s"
          repeatCount="indefinite"
        />
        <animateTransform
          attributeName="transform"
          attributeType="XML"
          type="rotate"
          dur="5s"
          from="0 0 0"
          to="360 0 0"
          repeatCount="indefinite"
        />
      </ph-cube>
    </template>

    Note: The coordinate space of slotted elements is relative to the contents of the icon viewBox, which is a 256x256 square. Only valid SVG elements will be rendered.

    Our Related Projects

    Community Projects

    If you've made a port of Phosphor and you want to see it here, just open a PR here!

    License

    MIT © phosphor-icons

    Install

    npm i phosphor-vue

    DownloadsWeekly Downloads

    500

    Version

    1.4.2

    License

    MIT

    Unpacked Size

    34.9 MB

    Total Files

    3163

    Last publish

    Collaborators

    • rektdeckard