skribble_icons_custom 0.1.1
skribble_icons_custom: ^0.1.1 copied to clipboard
Hand-drawn custom icon set for Skribble. A small SVG-manifest-based icon package generated with the Skribble rough icon pipeline.
skribble_icons_custom #
Hand-drawn custom icon set for Skribble.
This package demonstrates how to ship a standalone icon set using the Skribble rough icon pipeline and the svg-manifest kit. The 5 bundled icons are generated from plain SVG source files — no Material or third-party icon dependency required.
Icons #
| Identifier | Codepoint |
|---|---|
home |
0xe901 |
search |
0xe902 |
settings |
0xe903 |
star |
0xe904 |
favorite |
0xe905 |
Installation #
dependencies:
skribble: ^0.3.4
skribble_icons_custom: ^0.1.0
Usage #
By codepoint #
import 'package:skribble/skribble.dart';
import 'package:skribble_icons_custom/skribble_icons_custom.dart';
WiredIcon.custom(data: kCustomRoughIcons[0xe901]!)
By identifier #
import 'package:skribble_icons_custom/skribble_icons_custom.dart';
final data = lookupCustomRoughIconByIdentifier('home');
if (data != null) {
WiredIcon.custom(data: data)
}
All icons with the code-points map #
import 'package:skribble_icons_custom/skribble_icons_custom.dart';
// Iterate all available icons:
for (final entry in kCustomRoughIcons.entries) {
print('0x${entry.key.toRadixString(16)}');
}
// Iterate all identifier → codepoint entries:
for (final entry in kCustomRoughIconsCodePoints.entries) {
print('${entry.key}: 0x${entry.value.toRadixString(16)}');
}
Regenerating icons #
The icon map is generated by the Skribble rough icon pipeline. To regenerate after editing source SVGs or the manifest:
# from the workspace root
melos run rough-icons-custom
Or run the generator directly:
cd packages/skribble
dart run tool/generate_rough_icons.dart \
--kit svg-manifest \
--manifest ../skribble_icons_custom/tool/custom_icons.manifest.json \
--output ../skribble_icons_custom/lib/src/generated/custom_rough_icons.g.dart \
--map-name kCustomRoughIcons
Adding icons #
- Add a 24×24 SVG file to
icons/. - Add an entry to
tool/custom_icons.manifest.json:{ "identifier": "my_icon", "codePoint": "0xe906", "svgPath": "../icons/my_icon.svg" } - Add the identifier → codepoint entry to
kCustomRoughIconsCodePointsinlib/skribble_icons_custom.dart. - Run
melos run rough-icons-custom.
License #
Same as the root Skribble repository — see LICENSE.