@flownet/lib-create-ios-icons

Easily generate patterned icons with overlay text for iOS and macOS platforms using SVG patterns. The library leverages the power of GeoPattern, sharp, and tinycolor2.

Features:

• Generate uniquely patterned icons based on input text.
• Adjust the appearance of icons with overlay text and control text properties such as font, weight, and fill color.
• Save generated icons to specified directories.
• Define rounded corners for the icons.
• Adjust and select pattern styles with GeoPattern options.

Installation:

npm install @flownet/lib-create-ios-icons

Usage:

Import the main function and utilize it in your Node.js applications:

import createIcons from '@flownet/lib-create-ios-icons';

const options = {
  text: 'Pattern text',
  dir: './output',
  overlayText: 'Sp',
  fontFamily: 'Arial',
  fontWeight: 'normal',
  fill: 'white',
  roundFactor: 1,
  patternOptions: {
    color: '#FF5733',
    generator: 'octagons'
  }
};

createIcons(options);

API:

Here's a breakdown of the available options:

Required:

• text: Text used to generate the unique patterned icon.
• dir: Directory where the icons will be saved.

Optional:

• platform: Platform for which the icons are being created (ios or macos). Default: ios.
• overlayText: Overlay text for the icon. Default: Sp.
• fontFamily: Font family for the overlay text. Default: Arial.
• fontWeight: Font weight for the overlay text. Default: normal.
• fill: Color for the overlay text. If not specified, a complementary color to the pattern is selected.
• roundFactor: Factor to determine the rounded corner radius. Default: 1.
• patternOptions: GeoPattern options for adjusting the pattern style. These can include:
  • color: Specific color for the generated pattern.
  • baseColor: Base color for the pattern; other colors are derived from this.
  • generator: Type of pattern to generate (e.g. chevrons, octagons, etc.).

Refer to the GeoPattern documentation for more details on pattern options.