Roadtrip Icons Neo

Welcome to Roadtrip Icons Neo – an icon library designed specifically for Nuxt 3 and Vue applications. These icons are sourced from a dedicated Figma library to maintain consistency across design and development. Each icon is available in four sizes to meet various layout needs and includes helpful keywords to make searching quick and easy. The icons are based on Lucide Icons, a open-source icon library.

Features

• 4 Icon Sizes: Each icon comes in four sizes:

  • xs - Extra Small
  • sm - Small
  • md - Medium
  • lg - Large

• Keyword Search: Icons are tagged with keywords, enabling efficient and targeted searches to quickly locate the right icons for your project.

Icons without stroke

Some icons are not designed with a stroke and should not be affected by the dynamic strokeWidth adjustment. To handle this, add the name of these icons to the strokeWidthExceptions list in the RtIcon component.

Example:

const strokeWidthExceptions = ["drag-and-drop", /* other icons */];

This way, these icons will keep their original appearance regardless of the selected size.

Installation

Install the Roadtrip Icons Neo library via npm:

npm install roadtrip-icons-neo

Usage

To use an icon in your Nuxt 3 project, simply import the icon component and specify its size as needed:

<template>
  <RtIcon name="icon-name" size="md" />
</template>

<script setup>
import RtIcon from 'roadtrip-icons-neo'
</script>

Available Sizes

| Size | Description | |------|--------------------| | xs | Extra Small (16px) | | sm | Small (20px) | | md | Medium (24px) | | lg | Large (32px) |

License

This library is licensed under the MIT License. See the LICENSE file for details.

Thank you for choosing Roadtrip Icons Neo! Happy designing and developing!

Roadtrip Icons Neo

Welcome to Roadtrip Icons Neo – an icon library designed specifically for Nuxt 3 and Vue applications. These icons are sourced from a dedicated Figma library to maintain consistency across design and development. Each icon is available in four sizes to meet various layout needs and includes helpful keywords to make searching quick and easy. The icons are based on Lucide Icons, a open-source icon library.

Features

• 4 Icon Sizes: Each icon comes in four sizes:

  • xs - Extra Small
  • sm - Small
  • md - Medium
  • lg - Large

• Keyword Search: Icons are tagged with keywords, enabling efficient and targeted searches to quickly locate the right icons for your project.

Icons without stroke

Some icons are not designed with a stroke and should not be affected by the dynamic strokeWidth adjustment. To handle this, add the name of these icons to the strokeWidthExceptions list in the RtIcon component.

Example:

const strokeWidthExceptions = ["drag-and-drop", /* other icons */];

This way, these icons will keep their original appearance regardless of the selected size.

Git Flow & Contribution Workflow

This library uses a Git Flow branching model to ensure a clean and organized development process. Here's how to contribute:

Branch Types

• main: Always contains the latest stable release.
• develop: Integration branch for features and fixes. All development happens here before merging to main.
• feature/: For new icons or enhancements. Branch off from develop.
• bugfix/: For bug fixes. Branch off from develop.
• release/: For preparing a new release. Branch off from develop and merge into both main and develop when done.
• hotfix/: For urgent fixes to production. Branch off from main and merge into both main and develop.

Typical Workflows

1. Adding a New Icon

• Create a branch: feature/add-icon-iconname
• Add your icon in the appropriate directory.
• Update documentation if needed.
• Commit and push your changes.
• Open a pull request to develop.

2. Updating an Existing Icon

• Create a branch: feature/update-icon-iconname
• Make your changes.
• Update documentation if needed.
• Commit and push your changes.
• Open a pull request to develop.

3. Fixing a Bug

• Create a branch: bugfix/fix-description
• Fix the bug.
• Add or update tests if relevant.
• Commit and push your changes.
• Open a pull request to develop.

4. Release Process

• When ready for a new release, create a release/x.y.z branch from develop.
• Update version numbers and changelog.
• Merge the release branch into both main and develop.
• Tag the release on main.

5. Hotfixes

• For urgent production fixes, create a hotfix/x.y.z branch from main.
• Apply the fix, then merge into both main and develop.
• Tag the release on main.

Installation

Install the Roadtrip Icons Neo library via npm:

npm install roadtrip-icons-neo

Usage

To use an icon in your Nuxt 3 project, simply import the icon component and specify its size as needed:

<template>
  <RtIcon name="icon-name" size="md" />
</template>

<script setup>
import RtIcon from 'roadtrip-icons-neo'
</script>

Available Sizes

| Size | Description | |------|--------------------| | xs | Extra Small (16px) | | sm | Small (20px) | | md | Medium (24px) | | lg | Large (32px) |

License

This library is licensed under the MIT License. See the LICENSE file for details.

Thank you for choosing Roadtrip Icons Neo! Happy designing and developing!