Giter VIP home page Giter VIP logo

astraicons's Introduction

Astra Icons

AstraIcons

Getting Started

The easiest way to utilize these icons is to copy the SVG source from uiastra.com and directly embed it into your HTML:

<svg
  class="size-6 text-gray-500"
  fill="none"
  viewBox="0 0 24 24"
  stroke="currentColor"
  stroke-width="1.5"
>
  <rect x="2" y="2" width="20" height="20" rx="10" />
  <path
    d="M9 3C7.66667 8.84 7.66667 15.16 9 21"
    stroke-linecap="round"
    stroke-linejoin="round"
  />
  <path
    d="M15 3C16.3333 8.84 16.3333 15.16 15 21"
    stroke-linecap="round"
    stroke-linejoin="round"
  />
  <path d="M2 12L22 12" />
  <path d="M3 7L21 7" />
  <path d="M3 17L21 17" />
</svg>

These icons are designed to be easily styled by modifying the color CSS property, either directly or through utility classes such as text-gray-500 in frameworks like Tailwind CSS.

React Integration

Begin by installing @astraicons/react from npm:

npm install @astraicons/react

Then import each icon individually as a React component:

import { GlobalIcon } from "@astraicons/react/linear";

function MyComponent() {
  return (
    <div>
      <GlobalIcon className="size-6 text-blue-500" />
      <p>...</p>
    </div>
  );
}

The 24x24 linear icons can be imported from @astraicons/react/linear, the 24x24 bold icons from @astraicons/react/bold, and the 24x24 brand icons from @astraicons/react/brand.

Icons are named using upper camel case and always end with Icon.

View the full list of icon names on UNPKG โ†’

Vue Integration

First, install @astraicons/vue from npm:

npm install @astraicons/vue

Next, import each icon individually as a Vue component:

<template>
  <div>
    <GlobalIcon class="size-6 text-blue-500" />
    <p>...</p>
  </div>
</template>

<script setup>
import { GlobalIcon } from "@astraicons/vue/linear";
</script>

The 24x24 linear icons can be imported from @astraicons/vue/linear, the 24x24 bold icons from @astraicons/vue/bold, and the 24x24 brand icons from @astraicons/vue/brand.

Icons follow an upper camel case naming convention and always end with Icon.

View the full list of icon names on UNPKG โ†’

Contributing

While we welcome contributions to enhance the project, our current focus is on resolving issues like incorrect TypeScript types or improperly exported icons.

Please note that we are not accepting contributions for new icons.

Credit

This project uses parts from the HeroIcons library from TailwindLabs.

License

This library is released under the MIT license.

astraicons's People

Contributors

arunavo4 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.