@edifice-ui/editor NPM

Edifice Editor

npm bundlephobia

Getting Started

pnpm run build

pnpm run lint

If pnpm run lint shows issues, run this command to fix them.

pnpm run fix

pnpm run format

Component Guideline

Always document basic guideline of Component with JSDoc format. Used by Storybook to generate documentation.

/**
 * Primary UI component for user interaction
 */

Interface description

Always document typescript types and interface with JSDoc syntax. Used by Storybook to generate documentation.

// Interface description (e.g: TreeViewProps.tsx)
export interface ButtonProps {
  /**
   * Is this the principal call to action on the page?
   */
  primary?: boolean;
  /**
   * What background color to use
   */
  backgroundColor?: string;
  /**
   * How large should the button be?
   */
  size?: "small" | "medium" | "large";
  /**
   * Button contents
   */
  label: string;
  /**
   * Optional click handler
   */
  onClick?: () => void;
}

Index file inside `src` folder

Entry point of this Editor Library.
Import your component inside index.ts file.

export * from "./Button";

Dev

You can build your component using Storybook. See README

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

11 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

11 months ago

9 months ago

10 months ago

10 months ago

10 months ago

9 months ago

9 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

11 months ago

10 months ago

10 months ago

10 months ago

9 months ago

10 months ago

10 months ago

11 months ago

10 months ago

11 months ago

9 months ago

9 months ago

9 months ago

11 months ago

11 months ago

9 months ago

11 months ago

11 months ago

12 months ago

9 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

10 months ago

10 months ago

10 months ago

9 months ago

9 months ago

9 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

10 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

9 months ago

10 months ago

9 months ago

8 months ago

8 months ago

12 months ago

12 months ago

10 months ago

10 months ago

10 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

10 months ago

10 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

9 months ago

9 months ago

Edifice Editor

Getting Started

Build

Lint

Prettier

Component Guideline

Interface description

Index file inside src folder

Dev

Index file inside `src` folder