pantoken / packages/core/src / flutterIconManifest

Function: flutterIconManifest()

flutterIconManifest(names, assetDir?): string

Beta

Build a Flutter/Dart manifest of icon asset paths (for flutter_svg). Pair with the raw SVGs copied under assetDir.

Parameters

names

readonly string[]

Icon names.

assetDir?

string = "assets/pantoken/icons"

The asset directory the SVGs are copied to (default assets/pantoken/icons).

Returns

string

Dart source declaring a PanTokensIcons class of asset-path constants.

Examples

Default asset directory

import { flutterIconManifest } from "@pantoken/core";

flutterIconManifest(["arrow-left", "check-mark"]);
// → class PanTokensIcons {
//     static const String arrowLeft = 'assets/pantoken/icons/arrow-left.svg';
//     static const String checkMark = 'assets/pantoken/icons/check-mark.svg';
//   }

A custom asset directory

import { flutterIconManifest } from "@pantoken/core";

flutterIconManifest(["arrow-left"], "lib/icons");
// → static const String arrowLeft = 'lib/icons/arrow-left.svg';