Skip to content

Elora is an enchanting component library built in TypeScript for React projects.

Notifications You must be signed in to change notification settings

BrettThurs10/elora

Repository files navigation

Elora logo

Elora - A React component library

Elora is an enchanting component library built in TypeScript for React projects. It's purpose is to be a no fuss library to help you concoct whatever magical stuff you dream up. :D

Demo

https://brettthurs10.github.io/elora

Installation

Simply run 'npm install elora' to install to your React project.

Note: This library is still in it's infancy. The button element is available for now. More to come soon!

Components

Current components available are the button component, text field component, and Hero Icon component. More to come soon!

Hero Icons

This library utilizes Hero Icons. Whenever you see an Elora component use the prop 'heroIconsName' you may pass in the name of the HeroIcon you want that component to use. (See )

Sample usage

import React from 'react'
import Button from 'elora'

const MyButton = () => {
    return (
        <Button btnType='pill' onClick={() => alert('Bibbity bobbity boop')}>
            <p>Click me</p>
        </Button>
    )
}

const DownloadButton = () => {
    return (
        <Button heroIconsName='DownloadIcon' onClick={() => downloadFunction()}>
            <p>Download</p>
        </Button>
    )
}

const TextField = () => {
    return (
        <TextField
            inputType='icon'
            heroIconsName='UserIcon'
            placeholder='Username'
            onChange={() => validateUsername()}
        />
    )
}

Button props:

https://github.com/BrettThurs10/elora/blob/main/src/components/Button/IButton.tsx

TextField props:

https://github.com/BrettThurs10/elora/blob/main/src/components/TextField/ITextField.tsx

License

MIT © BrettThurs10

About

Elora is an enchanting component library built in TypeScript for React projects.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages