Preparing search index...

    Function getSymbol

    • Gets an SVG as a string or as a Data URL, with option to modify attributes.

      Parameters

      • symbolName: Symbols

        Name of the icon without extension .svg

      • options: SymbolOptions = {}

        Options to modify attributes or return as a Data URL

      Returns {
          setHeight: (
              height: string | number,
          ) => { setStroke: (stroke: string) => ...; setStrokeWidth: (strokeWidth: string | number) => ...; setWidth: (width: string | number) => ...; setHeight: (height: string | number) => ...; toString: () => string; toDataURL: () => string; };
          setStroke: (
              stroke: string,
          ) => { setStroke: (stroke: string) => ...; setStrokeWidth: (strokeWidth: string | number) => ...; setWidth: (width: string | number) => ...; setHeight: (height: string | number) => ...; toString: () => string; toDataURL: () => string; };
          setStrokeWidth: (
              strokeWidth: string | number,
          ) => { setStroke: (stroke: string) => ...; setStrokeWidth: (strokeWidth: string | number) => ...; setWidth: (width: string | number) => ...; setHeight: (height: string | number) => ...; toString: () => string; toDataURL: () => string; };
          setWidth: (
              width: string | number,
          ) => { setStroke: (stroke: string) => ...; setStrokeWidth: (strokeWidth: string | number) => ...; setWidth: (width: string | number) => ...; setHeight: (height: string | number) => ...; toString: () => string; toDataURL: () => string; };
          toDataURL: () => string;
          toString: () => string;
      }

      SVG as string or Data URL

      import { getSymbol } from 'western-signs'

      // Get the symbol with initial options
      const initialSymbol = getSymbol('taurus', { stroke: 'blue', strokeWidth: 2 })
      // Modify attributes using method chaining
      const modifiedSymbol = initialSymbol.setStroke('green').setStrokeWidth(3)

      // Log the modified SVG as a string
      console.log(symbol.toString())

      // Log the modified SVG as a Data URL
      console.log(symbol.toDataURL())

      Will throw an error if the specified SVG file is not found