Getting Started with AkarUI

Getting Started with AkarUI

May 15, 2023
Alex Johnson
Tutorials
5 min read

Getting Started with AkarUI

AkarUI is a collection of beautifully designed UI components that you can copy and paste into your applications. Each component is built with a focus on aesthetics, accessibility, and performance.

Installation

The fastest way to get started with AkarUI is to browse our component library and copy the code for the components you need. However, some components may require additional dependencies.

For React components, you may need to install the following dependencies:

npm install framer-motion @react-three/fiber @react-three/drei three

Basic Usage

Once you have the necessary dependencies installed, you can start using AkarUI components in your project. Here's an example of how to use the GlowingButton component:

import { GlowingButton } from '@/components/ui-components/glowing-button';

export default function MyComponent() {

return (

<div>

<h1>Welcome to My App</h1>

<GlowingButton href="/contact" color="#f0f">

Contact Us

</GlowingButton>

</div>

);

}

Customizing Components

Most AkarUI components accept props that allow you to customize their appearance and behavior. For example, the GlowingButton component accepts the following props:

  • `href`: The URL to navigate to when the button is clicked
  • `color`: The color of the button's glow effect
  • `size`: The size of the button (sm, md, lg)
  • `className`: Additional CSS classes to apply to the button
  • Next Steps

    Now that you know the basics, you can explore our component library and start building beautiful interfaces with AkarUI. Check out our documentation for more detailed information on each component and how to use them.

    AJ

    Alex Johnson

    Technical Writer & UI Developer at AkarUI. Passionate about creating beautiful and accessible user interfaces.