to-svg

title: Export icon as SVG instance in icon set
types:
  IconSet: './index.md'
  SVG: '../svg/index.md'
functions:
  fromSVG: './from-svg.md'

toSVG()

This function is part of [type]IconSet class in Iconify Tools.

Function [func]toSVG() exports icon as [type]SVG instance.

It is used to process icon using functions that work with [type]SVG instances.

Important notice

[type]SVG instance is not synchronised with an icon set.

After changing icon, you need to update entry in [type]IconSet using [func]fromSVG() method.

Usage

The function has the following parameter:

• [prop]name, [type]string. Icon name.

Function returns [type]SVG instance on success, [type]null on error.

Example

src: libraries/tools/icon-set/to-svg.ts
title: 'example.ts'
extra:
  - src: libraries/tools/icon-set/to-svg.svg
    title: 'Result:'