Skip to content

⚡ Simple, Customizable SVG icons sourced from untitled UI with support for Framer motion for your React applications

License

Notifications You must be signed in to change notification settings

alexbot89/untitledui-js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Banner

Get Started → Documentation

Installation

1. Setup with framer-motion

npm i untitledui-js framer-motion

2. Setup without framer-motion (base)

npm i untitledui-js-base

Basic Usage

1. Imports

import { Communication } from "untitledui-js"
<-- Category Import-->

import { AnnotationAlert } from "untitledui-js"
<-- Direct Import  -->

2. Rendering on the DOM

//...imports

const App = () => {
  return (
    <Fragment>
      <Communication.AnnotationAlert />

      <AnnotationAlert />
    </Fragment>
  );
};

3. Customization

return (
  <AnnotationAlert
    size={"15"} //adjusts both width and height properties
    pathProps={{
      ...props,
    }} //allows the adjustment of the path properties directly
    {...props} //other svg properties
  />
);

About

⚡ Simple, Customizable SVG icons sourced from untitled UI with support for Framer motion for your React applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%