@js-empire/emperor-ui 1.0.1 → 1.2.0

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+pnpm run format
+git add .
+pnpm run lint
+pnpm run build

package/.storybook/main.ts

@@ -4,16 +4,7 @@ import tsconfigPaths from "vite-tsconfig-paths";
 
 const config: StorybookConfig = {
   stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
-  addons: [
-    "@chromatic-com/storybook",
-    "@storybook/addon-vitest",
-    "@storybook/addon-a11y",
-    "@storybook/addon-docs",
-    "@storybook/addon-links",
-    "@storybook/addon-essentials",
-    "@storybook/addon-onboarding",
-    "@storybook/addon-interactions",
-  ],
+  addons: [],
   framework: {
     name: "@storybook/react-vite",
     options: {},
@@ -22,7 +13,7 @@ const config: StorybookConfig = {
     config.plugins?.push(
       /** @see https://github.com/aleclarson/vite-tsconfig-paths */
       tsconfigPaths({
-        projects: [path.resolve(path.dirname(__dirname), "tsconfig.json")],
+        projects: [path.resolve("..", "tsconfig.json")],
       }),
     );
 

package/.storybook/preview.ts

@@ -1,5 +1,5 @@
 import type { Preview } from "@storybook/react-vite";
-import "../src/index.css";
+import "../src/styles/globals.css";
 
 const preview: Preview = {
   parameters: {

package/.storybook/vitest.setup.ts

@@ -1,7 +1,7 @@
 import * as a11yAddonAnnotations from "@storybook/addon-a11y/preview";
-import { setProjectAnnotations } from '@storybook/react-vite';
-import * as projectAnnotations from './preview';
+import { setProjectAnnotations } from "@storybook/react-vite";
+import * as projectAnnotations from "./preview";
 
 // This is an important step to apply the right configuration when testing your stories.
 // More info at: https://storybook.js.org/docs/api/portable-stories/portable-stories-vitest#setprojectannotations
-setProjectAnnotations([a11yAddonAnnotations, projectAnnotations]);
+setProjectAnnotations([a11yAddonAnnotations, projectAnnotations]);

package/.vscode/extensions.json

@@ -0,0 +1 @@
+{}

package/README.md

@@ -1 +1,47 @@
-# EmperorUI
+# Emperor UI
+
+![Emperor UI Logo](./public/images/emperor-ui-logo.png)
+
+## Intro
+
+A modular UI library built for React and Nextjs. It depends on HeroUI to implement advanced organisms and pages.
+
+Each one of them has props to control every aspect pf the component, with enabling/disabling the optional features.
+
+---
+
+## Components
+
+### Item Card
+
+- Image
+- Title
+- Subtitle (for description)
+- Price
+- Drop-down with actions and a dots-icon for opening it
+
+### Listings
+
+- Listing any type of components
+- Pagination or infinite scrolling
+- Specifying the page size
+- View controller: list, grid, carousel (swiper)
+
+### Details page
+
+- Breadcrumbs
+- Image or carousel
+- Title
+- Subtitle
+- Description
+- Price
+
+### Filter
+
+- Filter layouts: side box on desktop, drawer on mobile
+- Custom filter items with different types:
+  - search term
+  - checkbox
+  - Multiple checkboxes under an accordion
+  - autocomplete or select box
+- Action buttons: apply filters, reset filters