@edusogno/ui v0.2.15
π Why
- The component designs defy the norms of Material UI, forging a new path in UI magic.
- Reusability is our secret potion for all developed components.
- Enhancing performance with components that dance with alternative CSS-IN-JS libraries and the rhythm of Tailwind!
Built With
Edusogno Library embraces the power of:
π Getting Started
The library unfolds its chapters through subpackages under the mystical namespace @edusogno
:
composites
- Home to composite components like magical popups and more!primitives
- A treasure trove of basic components, the essence of UI magic in buttons!inputs
- A realm of common input components, each with its unique spell.layouts
- The sacred place containing common layout components, designed for magical arrangements.lib
- A mysterious package containing common functions, the secret scrolls of the library.
Prerequisites
This library requires brave adventurers to have the following prerequisites:
- π Node 18+
- π¦ NPM
- An IDE (e.g., Webstorm or VS Code) is recommended, as every great adventure needs a trusty companion!
- π Vite 4.2+
This project uses NPM as its package manager, the elixir of package management. It comes bundled with Node.js. To install the latest version of Node.js, visit the Node.js website.
Beware! Do not use
yarn
or any other package manager to install packages. Usenpm
instead. This is becausenpm
uses apackage-lock.json
file to lock down the versions of the packages, ensuring harmony in the magical versions.
Installation
- First run
npm install @edusogno/ui
- Add this line to your imports in
main.tsx
orApp.tsx
import "@edusogno/ui/css";
- Update your tailwind configuration file
tailwind.config.js
as followscontent: [ "./node_modules/@edusogno/**/**/**/*.{ts,js,jsx,tsx,mdx}", ], presets: [require("@edusogno/ui/presets.js")],
- Next install any of the subpackages e.g
npm install @edusogno/primitives
Folder Structure
The folder is structured as follows:
edusogo-ui
βββ APPLICATION_STRUCTURE.md
βββ assets
βΒ Β βββ storybook-icon.svg
βββ CHANGELOGS.md
βββ CONTRIBUTION.md
βββ index.css
βββ package.json
βββ package-lock.json
βββ packages
βΒ Β βββ composites
βΒ Β βΒ Β βββ lib
βΒ Β βΒ Β βΒ Β βββ booking-date.tsx
βΒ Β βΒ Β βΒ Β βββ calendar.tsx
βΒ Β βΒ Β βΒ Β βββ hours.tsx
βΒ Β βΒ Β βΒ Β βββ index.ts
βΒ Β βΒ Β βΒ Β βββ popup-header.tsx
βΒ Β βΒ Β βΒ Β βββ popup.tsx
βΒ Β βΒ Β βΒ Β βββ video.tsx
βΒ Β βΒ Β βββ package.json
βΒ Β βΒ Β βββ stories
βΒ Β βΒ Β βΒ Β βββ booking-date.stories.ts
βΒ Β βΒ Β βΒ Β βββ calendar.stories.ts
βΒ Β βΒ Β βΒ Β βββ hours.stories.ts
βΒ Β βΒ Β βΒ Β βββ popup.stories.ts
βΒ Β βΒ Β βΒ Β βββ video-player.stories.ts
βΒ Β βΒ Β βββ tsconfig.json
βΒ Β βΒ Β βββ tsup.config.ts
βΒ Β βββ graphics
βΒ Β βΒ Β βββ assets
βΒ Β βΒ Β βΒ Β βββ bgHeaderLg.png
βΒ Β βΒ Β βΒ Β βββ bgHeaderSmall.png
βΒ Β βΒ Β βββ lib
βΒ Β βΒ Β βΒ Β βββ ca-black-logo.tsx
βΒ Β βΒ Β βΒ Β βββ ca-white-logo.tsx
βΒ Β βΒ Β βΒ Β βββ icons.tsx
βΒ Β βΒ Β βΒ Β βββ index.ts
βΒ Β βΒ Β βββ package.json
βΒ Β βΒ Β βββ tsconfig.json
βΒ Β βΒ Β βββ tsup.config.ts
βΒ Β βββ index.ts
βΒ Β βββ inputs
βΒ Β βΒ Β βββ lib
βΒ Β βΒ Β βΒ Β βββ address-input.tsx
βΒ Β βΒ Β βΒ Β βββ date-picker.tsx
βΒ Β βΒ Β βΒ Β βββ file-upload.tsx
βΒ Β βΒ Β βΒ Β βββ index.ts
βΒ Β βΒ Β βΒ Β βββ outlined-input.tsx
βΒ Β βΒ Β βΒ Β βββ outlined-password-input.tsx
βΒ Β βΒ Β βΒ Β βββ outlined-select.tsx
βΒ Β βΒ Β βΒ Β βββ outlined-text-area.tsx
βΒ Β βΒ Β βΒ Β βββ outline-phone-input.tsx
βΒ Β βΒ Β βΒ Β βββ underlined-input.tsx
βΒ Β βΒ Β βΒ Β βββ underlined-select.tsx
βΒ Β βΒ Β βββ package.json
βΒ Β βΒ Β βββ stories
βΒ Β βΒ Β βΒ Β βββ address.stories.ts
βΒ Β βΒ Β βΒ Β βββ date-picker.stories.ts
βΒ Β βΒ Β βΒ Β βββ phone.stories.ts
βΒ Β βΒ Β βββ tsconfig.json
βΒ Β βΒ Β βββ tsup.config.ts
βΒ Β βββ layouts
βΒ Β βΒ Β βββ assets
βΒ Β βΒ Β βΒ Β βββ bgHeaderLg.png
βΒ Β βΒ Β βΒ Β βββ bgHeaderSmall.png
βΒ Β βΒ Β βββ lib
βΒ Β βΒ Β βΒ Β βββ auth-content.tsx
βΒ Β βΒ Β βΒ Β βββ auth-layout.tsx
βΒ Β βΒ Β βΒ Β βββ auth-page-footer.tsx
βΒ Β βΒ Β βΒ Β βββ auth-page-heading.tsx
βΒ Β βΒ Β βΒ Β βββ content-dashboard.tsx
βΒ Β βΒ Β βΒ Β βββ dashboard.tsx
βΒ Β βΒ Β βΒ Β βββ global.d.ts
βΒ Β βΒ Β βΒ Β βββ index.ts
βΒ Β βΒ Β βΒ Β βββ page-footer.tsx
βΒ Β βΒ Β βΒ Β βββ page-heading.tsx
βΒ Β βΒ Β βΒ Β βββ side-bar.tsx
βΒ Β βΒ Β βββ package.json
βΒ Β βΒ Β βββ stories
βΒ Β βΒ Β βΒ Β βββ auth-layout.stories.ts
βΒ Β βΒ Β βββ tsconfig.json
βΒ Β βΒ Β βββ tsup.config.ts
βΒ Β βββ lib
βΒ Β βΒ Β βββ lib
βΒ Β βΒ Β βΒ Β βββ motion
βΒ Β βΒ Β βΒ Β βΒ Β βββ fade-in-bottom.ts
βΒ Β βΒ Β βΒ Β βββ stitches.ts
βΒ Β βΒ Β βΒ Β βββ utils.ts
βΒ Β βΒ Β βββ package.json
βΒ Β βΒ Β βββ tsconfig.json
βΒ Β βΒ Β βββ tsup.config.ts
βΒ Β βββ playground.stories.ts
βΒ Β βββ playground.tsx
βΒ Β βββ primitives
βΒ Β βββ lib
βΒ Β βΒ Β βββ accordion.tsx
βΒ Β βΒ Β βββ box.tsx
βΒ Β βΒ Β βββ button.tsx
βΒ Β βΒ Β βββ checkbox.tsx
βΒ Β βΒ Β βββ command.tsx
βΒ Β βΒ Β βββ dialog.tsx
βΒ Β βΒ Β βββ dropdown-menu.tsx
βΒ Β βΒ Β βββ hover-card.tsx
βΒ Β βΒ Β βββ index.ts
βΒ Β βΒ Β βββ input.tsx
βΒ Β βΒ Β βββ loading-button.tsx
βΒ Β βΒ Β βββ popover.tsx
βΒ Β βΒ Β βββ progress.tsx
βΒ Β βΒ Β βββ scroll-area.tsx
βΒ Β βΒ Β βββ select.tsx
βΒ Β βΒ Β βββ spinner.tsx
βΒ Β βΒ Β βββ stitches.ts
βΒ Β βΒ Β βββ tabs.tsx
βΒ Β βΒ Β βββ textarea.tsx
βΒ Β βΒ Β βββ toast.tsx
βΒ Β βΒ Β βββ toggle-group.tsx
βΒ Β βΒ Β βββ toggle.tsx
βΒ Β βΒ Β βββ utils.ts
βΒ Β βββ package.json
βΒ Β βββ README.md
βΒ Β βββ stories
βΒ Β βΒ Β βββ button.stories.ts
βΒ Β βββ tsconfig.json
βΒ Β βββ tsup.config.ts
βββ postcss.config.mjs
βββ README.md
βββ tailwind.config.js
βββ tsconfig.json
βββ tsup.config.ts
βββ turbo.json
βββ vite.config.js
- The library is currently in its early development stages, and as a result, the components within it are subject to frequent changes. Therefore, most modifications and updates will be released in the form of patches.
Contribute
Review the Contribution guide to understand how you can actively participate and contribute to the library's development.
Roadmap
Components
- Inputs
- Outlined inputs
- Input
- Phone Input
- AddressInput
- DatePicker
- Underlined
- Outlined inputs
- Composites
- Video Player
- Calendar
- Hour Selector
- Popup
- Primitives
- Buttons
- Input
- Accordion
- Dialogs
- Popovers
- Toast
- Select
- Inputs
Stories(Documentation)
- Docs (In Progress)
- Contribution Docs
- Components Docs (In Progress)
- Unit Tests and Interaction Test
- Docs (In Progress)
Contributing
If you're eager to contribute to this project, familiarize yourself with the guidelines outlined in the Contributing Guide.
Changelog
Refer to the Changelog for a detailed history of modifications, updates, and improvements made to the library.
License
The source code is protected under the MIT license. Explore the terms and conditions in the LICENSE file for comprehensive information.
Contact
For any inquiries or questions, create an issue in the GitHub repository.