Giter Club home page Giter Club logo

jengaicons's Introduction

Jenga Icons

Jenga Icons is a collection of adaptable icons designed for use in interfaces, diagrams, and other applications.

NPM Version Discord

Installation

# with npm
npm install @jengaicons/react

# with yarn
yarn add @jengaicons/react

# with pnpm
pnpm add @jengaicons/react

Usage

import React from "react"
import ReactDOM from "react-dom"
import { Activity, ActivityFill } from "@jengaicons/react"

const App = () => {
  return (
    <div>
      <Activity />
      <ActivityFill color='#6864d4' size={32} />
    </div>
  )
}

ReactDOM.render(<App />, document.getElementById("root"))

Optimization

Tired of icons hogging your memory by loading all icons ?
Solution for NextJS is to use modularizeImports feature

// next.config.mjs
import { nextJsModularizeImport } from "@jengaicons/react"

const nextConfig = {
  modularizeImports: {
    "@jengaicons/react": nextJsModularizeImport,
  },
}

export default nextConfig

At Outpost, we use nextjs as our primary frontend framework so we've added solution only for it but we would love to know, what framework you use so we can add support for those too! Just create a issue

Global Configuration (uses React Context API)

Jenga Icons simplifies the process of applying a default style to all icons by utilizing React Context. By creating an JengaIconContext.Provider at the root of the application or at a higher level in the component tree than the icons, you can pass a configuration object with properties that will serve as the default style for all icons.

import React from "react"
import ReactDOM from "react-dom"
import { Activity, ActivityFill, JengaIconContext } from "@jengaicons/react"

const App = () => {
  return (
    <div>
      <JengaIconContext.Provider
        value={{
          color: "red",
        }}
      >
        <Activity /> {/** icon with red color */}
        <ActivityFill color='blue' /> {/** icon with blue color */}
      </JengaIconContext.Provider>
    </div>
  )
}

ReactDOM.render(<App />, document.getElementById("root"))

In order to style icons differently in different areas of an application, you have the option to create multiple Contexts. Each Context will define a specific styling for icons within its respective region. Icons will utilize the nearest Context above them in the component tree to determine their individual style.

Important: The context will additionally transmit any supplied SVG props to icon instances, offering utility in tasks such as including accessible aria-labels, classNames, and more.

Props

The icon components can receive all the props that a standard SVG element can, which includes inline style objects, onClick handlers, and other properties. Generally, the key props used to style the icons are:

  • color?: string determines the color of the icon's stroke and fill. It accepts CSS color strings, including hex, rgb, rgba, hsl, hsla, named colors. currentColor is the default color.
  • size?: number | string specifies the height and width of the icon. It accepts values as a number or a string with units in px, %, em, rem, pt, cm, mm, or in.
  • weight?: number | string changes the thinkness / stroke-width of icons. Default is 2px (only applies to regular icons)
  • mirrored?: boolean flips the icon horizontally, which can be helpful in languages that use RTL text orientation.
  • alt?: string provides accessible alt text for the icon.
  • style?: object specifies the style prop object which will be passed to underlying <svg /> element

License

Jenga Icons is a project by Outpost.

Released under the MIT License.

jengaicons's People

Contributors

shubham-kaushal avatar sahilshahane avatar staranbeer avatar github-actions[bot] avatar darshansrc 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.