https://github.com/headwindz/figx

A comprehensive and reliable figma utilities library
https://github.com/headwindz/figx

figma figma-plugin utilities

Last synced: 3 months ago
JSON representation

A comprehensive and reliable figma utilities library

• Host: GitHub
• URL: https://github.com/headwindz/figx
• Owner: headwindz
• License: mit
• Created: 2021-12-22T15:17:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T03:17:45.000Z (9 months ago)
• Last Synced: 2024-05-18T17:49:00.751Z (8 months ago)
• Topics: figma, figma-plugin, utilities
• Language: TypeScript
• Homepage: https://figx.cool/
• Size: 766 KB
• Stars: 48
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-figma - figx - A comprehensive and reliable figma utilities library. (Plugins development)

README

        


  
Figx





A comprehensive and reliable figma utilities library

[![npm-version-img]][npm-link] [![npm-downloads-img]][npm-link] [![license-img]][license-link] [![bundle-size-img]](https://bundlephobia.com/result?p=figx)

[npm-link]: https://www.npmjs.com/package/figx

[npm-version-img]: https://img.shields.io/npm/v/figx.svg?style=flat

[npm-downloads-img]: https://img.shields.io/npm/dm/figx.svg?style=flat

[license-img]: https://img.shields.io/badge/license-MIT-blue.svg

[license-link]: https://github.com/n0ruSh/figx/blob/main/LICENSE

[bundle-size-img]: https://img.shields.io/bundlephobia/minzip/figx?cacheSeconds=1800



## 📚 Documentation

- [Home](https://figx.cool)

- [Guide](https://figx.cool/guide)

- [Utilities](https://figx.cool/utilities)

## ✨ Features

- A comprehensive collection of utilities

- Easy to learn and use with clear documentation

- Written in TypeScript with native type support

## 📦 Install

```bash

$ npm install figx --save

# or

$ yarn add figx

```

## 🔨 Usage

```ts

import { toRgb, ColorFormat } from 'figx';

toRgb('#FF0000'); // => 'rgb(255, 0, 0)';

toRgb({ r: 255, g: 0, b: 0 }, ColorFormat.ARRAY); // => [255, 0, 0]

toRgb('hsl(0, 100%, 50%)', ColorFormat.OBJECT); // => { r: 255, g: 0, b: 0 }

```

## 💻 Demos

- [Sandbox][sandbox-link]

- [Runkit][runkit-link]

[sandbox-link]: https://codesandbox.io/s/demo-316l9?file=/src/index.js

[runkit-link]: https://runkit.com/n0rush/61d919edcdc69d0008742627

## 🤝 Contributing

```bash

$ git clone [email protected]:n0ruSh/figx.git

$ yarn

$ yarn start

```

Open your browser and visit http://127.0.0.1:8000

## 🙏 Credit

Inspired by the following awesome work:

[create-figma-plugin](https://github.com/yuanqing/create-figma-plugin)

[figma-plugin-helpers](https://github.com/figma-plugin-helper-functions/figma-plugin-helpers)