elseware-ui 2.26.2 → 2.27.0

package/README.md

@@ -1,109 +1,109 @@
-# elseware UI
-
-## Component Imports Structure
-
-```javascript
-// External
-import { ReactNode } from "react";
-
-// Internal
-import { cn } from "@/utils";
-
-// Types
-import { BaseComponentProps } from "@/interfaces";
-import { Variant, Shape, Size } from "@/types";
-
-// Data
-import {
-  shapes,
-  variants,
-  borderVariants,
-  avatarSizes,
-} from "@/data/styles";
-```
-
-Copy the following and define the component imports accordingly
-
-```javascript
-// External
-
-// Internal
-
-// Types
-
-// Data
-```
-
-
-## Folder Hierarchy
-- components: Base UI primitives (buttons, inputs, modals, etc.)
-- compositions: Composite reusable structures built from primitives
-- data: Metadata used on the components/compositions
-- layouts: Page layouts that can be used to quickly structure the page formats
-- styles: Tailwind/CSS stylings
-- types: Custom react types
-- utils: Reusable utility functions and hooks
-
-## Setup
-
-Install the dependendecies via `npm i`.
-
-## Run Storybook 
-
-To test the components and its features start storybook using `npm run dev`.
-
-## Build
-
-Run `npm run build` to build the UI framework.
-
-## Publishing to npm
-
-### Publishing a New Version
-
-1. **Update the version number**:
-   - Before publishing a new version, update the version in `package.json` following [semantic versioning](https://semver.org/).
-   - Example:
-     ```json
-     {
-       "name": "elseware-ui",
-       "version": "1.0.1",
-       ...
-     }
-     ```
-
-2. **Build the UI Framework**:
-   - Run the following command to ensure your changes are built and ready to be published:
-     ```bash
-     npm run build
-     ```
-
-3. **Login to npm**:
-   - If you're not already logged in to npm, log in using:
-     ```bash
-     npm login
-     ```
-
-4. **Publish the package**:
-   - To publish the package, run the following command:
-     ```bash
-     npm publish --access public
-     ```
-   - Make sure the package name in `package.json` is unique and does not conflict with other packages on npm.
-
-### Unpublishing an Older Version
-
-If you need to unpublish a specific version of the package:
-
-1. **Unpublish a specific version**:
-   - To unpublish a specific version of your package (e.g., `1.0.0`), run:
-     ```bash
-     npm unpublish elseware-ui@1.0.0
-     ```
-
-2. **Unpublish the entire package**:
-   - If you need to unpublish the entire package, you can run the following command (not recommended for public packages):
-     ```bash
-     npm unpublish elseware-ui --force
-     ```
-
-   **Note:** Be cautious when using `--force` as npm restricts package unpublishing for packages that are older than 72 hours to avoid breaking dependencies.
+# elseware UI
+
+## Component Imports Structure
+
+```javascript
+// External
+import { ReactNode } from "react";
+
+// Internal
+import { cn } from "@/utils";
+
+// Types
+import { BaseComponentProps } from "@/interfaces";
+import { Variant, Shape, Size } from "@/types";
+
+// Data
+import {
+  shapes,
+  variants,
+  borderVariants,
+  avatarSizes,
+} from "@/data/styles";
+```
+
+Copy the following and define the component imports accordingly
+
+```javascript
+// External
+
+// Internal
+
+// Types
+
+// Data
+```
+
+
+## Folder Hierarchy
+- components: Base UI primitives (buttons, inputs, modals, etc.)
+- compositions: Composite reusable structures built from primitives
+- data: Metadata used on the components/compositions
+- layouts: Page layouts that can be used to quickly structure the page formats
+- styles: Tailwind/CSS stylings
+- types: Custom react types
+- utils: Reusable utility functions and hooks
+
+## Setup
+
+Install the dependendecies via `npm i`.
+
+## Run Storybook 
+
+To test the components and its features start storybook using `npm run dev`.
+
+## Build
+
+Run `npm run build` to build the UI framework.
+
+## Publishing to npm
+
+### Publishing a New Version
+
+1. **Update the version number**:
+   - Before publishing a new version, update the version in `package.json` following [semantic versioning](https://semver.org/).
+   - Example:
+     ```json
+     {
+       "name": "elseware-ui",
+       "version": "1.0.1",
+       ...
+     }
+     ```
+
+2. **Build the UI Framework**:
+   - Run the following command to ensure your changes are built and ready to be published:
+     ```bash
+     npm run build
+     ```
+
+3. **Login to npm**:
+   - If you're not already logged in to npm, log in using:
+     ```bash
+     npm login
+     ```
+
+4. **Publish the package**:
+   - To publish the package, run the following command:
+     ```bash
+     npm publish --access public
+     ```
+   - Make sure the package name in `package.json` is unique and does not conflict with other packages on npm.
+
+### Unpublishing an Older Version
+
+If you need to unpublish a specific version of the package:
+
+1. **Unpublish a specific version**:
+   - To unpublish a specific version of your package (e.g., `1.0.0`), run:
+     ```bash
+     npm unpublish elseware-ui@1.0.0
+     ```
+
+2. **Unpublish the entire package**:
+   - If you need to unpublish the entire package, you can run the following command (not recommended for public packages):
+     ```bash
+     npm unpublish elseware-ui --force
+     ```
+
+   **Note:** Be cautious when using `--force` as npm restricts package unpublishing for packages that are older than 72 hours to avoid breaking dependencies.

package/build/components/general/index.d.ts

@@ -1,2 +1 @@
 export * from "./content-area";
-export * from "./sidebar";

package/build/components/markdown/{editor → com/editor}/MarkdownEditor.d.ts

@@ -1,5 +1,5 @@
 import { FieldHookConfig } from "formik";
-import "../../../styles/components/markdown/index.css";
+import "../../../../styles/components/markdown/index.css";
 import "@mdxeditor/editor/style.css";
 interface MarkdownEditorProps {
     placeholder?: string;

package/build/components/markdown/com/toc/MarkdownTOC.d.ts

@@ -0,0 +1,5 @@
+interface MarkdownTOCProps {
+    title?: string;
+}
+declare function MarkdownTOC({ title }: MarkdownTOCProps): import("react/jsx-runtime").JSX.Element | null;
+export default MarkdownTOC;

package/build/components/markdown/{viewer → com/viewer}/MarkdownViewer.d.ts

@@ -1,7 +1,7 @@
-import "../../../styles/components/markdown/index.css";
 import "@mdxeditor/editor/style.css";
+import "../../../../styles/components/markdown/index.css";
 interface MarkdownViewerProps {
-    value: string;
+    value?: string;
 }
 declare function MarkdownViewer({ value }: MarkdownViewerProps): import("react/jsx-runtime").JSX.Element;
 export default MarkdownViewer;

package/build/components/markdown/hooks/useMarkdown.d.ts

@@ -0,0 +1 @@
+export declare function useMarkdown(): import("../provider/MarkdownContext").MarkdownContextType | null;

package/build/components/markdown/index.d.ts

@@ -1,2 +1,5 @@
-export * from "./editor";
-export * from "./viewer";
+import MarkdownEditor from "./com/editor/MarkdownEditor";
+import MarkdownTOC from "./com/toc/MarkdownTOC";
+import MarkdownViewer from "./com/viewer/MarkdownViewer";
+import MarkdownProvider from "./provider/MarkdownProvider";
+export { MarkdownEditor, MarkdownTOC, MarkdownViewer, MarkdownProvider };

package/build/components/markdown/provider/MarkdownContext.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { MarkdownHeading } from "../types/markdown";
+export interface MarkdownContextType {
+    markdown: string;
+    headings: MarkdownHeading[];
+    activeHeading: string;
+    setActiveHeading: (id: string) => void;
+}
+export declare const MarkdownContext: import("react").Context<MarkdownContextType | null>;

package/build/components/markdown/provider/MarkdownProvider.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+interface MarkdownProviderProps {
+    markdown: string;
+    children: React.ReactNode;
+}
+declare function MarkdownProvider({ markdown, children }: MarkdownProviderProps): import("react/jsx-runtime").JSX.Element;
+export default MarkdownProvider;

package/build/components/markdown/types/markdown.d.ts

@@ -0,0 +1,5 @@
+export interface MarkdownHeading {
+    id: string;
+    text: string;
+    level: number;
+}

package/build/components/markdown/utils/extractHeadings.d.ts

@@ -0,0 +1,2 @@
+import { MarkdownHeading } from "../types/markdown";
+export declare function extractHeadings(markdown: string): MarkdownHeading[];

package/build/components/markdown/utils/generateHeadingNumbers.d.ts

@@ -0,0 +1,5 @@
+import { MarkdownHeading } from "../types/markdown";
+export interface NumberedHeading extends MarkdownHeading {
+    numbering: string;
+}
+export declare function generateHeadingNumbers(headings: MarkdownHeading[]): NumberedHeading[];

package/build/components/markdown/utils/sanitizeHeading.d.ts

@@ -0,0 +1 @@
+export declare function sanitizeHeading(text: string): string;

package/build/components/markdown/utils/slugify.d.ts

@@ -0,0 +1 @@
+export declare function slugify(text: string): string;

package/build/components/navigation/menu/Menu.d.ts

@@ -1,2 +1,2 @@
 import { MenuProps } from "./types";
-export declare const Menu: ({ items, defaultMenuElements, className, selectedKey, defaultSelectedKey, navigate }: MenuProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Menu: ({ items, className, navigate, defaultMenuElements, currentPath, }: MenuProps) => import("react/jsx-runtime").JSX.Element;

package/build/components/navigation/menu/index.d.ts

@@ -2,5 +2,6 @@ import { Menu } from "./Menu";
 import { MenuGroup } from "./com/MenuGroup";
 import { MenuItem } from "./com/MenuItem";
 import { MenuItemTitle } from "./com/MenuItemTitle";
-export { Menu, MenuGroup, MenuItem, MenuItemTitle };
+import { MenuNode } from "./types";
+export { Menu, MenuGroup, MenuItem, MenuItemTitle, MenuNode };
 export * from "./types";

package/build/components/navigation/menu/types.d.ts

@@ -31,7 +31,6 @@ export interface MenuProps {
     items: MenuNode[];
     defaultMenuElements?: DefaultMenuElements;
     className?: string;
-    selectedKey?: string;
-    defaultSelectedKey?: string;
     navigate?: (to: string) => void;
+    currentPath?: string;
 }

package/build/compositions/navigation/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./box-nav";
+export * from "./sidebar";
 export * from "./top-nav";

package/build/compositions/navigation/sidebar/Sidebar.d.ts

@@ -0,0 +1,10 @@
+import { BaseComponentProps } from "../../../interfaces";
+import { MenuNode } from "../../../components/navigation/menu";
+import "./sidebar.css";
+export interface SidebarProps extends BaseComponentProps {
+    items?: MenuNode[];
+    navigate?: (to: string) => void;
+    currentPath?: string;
+}
+declare function Sidebar({ items, navigate, currentPath, className, ...rest }: SidebarProps): import("react/jsx-runtime").JSX.Element;
+export default Sidebar;

package/build/data/test/md/index.d.ts

@@ -0,0 +1,2 @@
+import sample from "./sample.md";
+export { sample };

package/build/data/test/test-data.d.ts

@@ -18,4 +18,3 @@ export declare const artifactOptions: {
     label: string;
     value: string;
 }[];
-export declare const sampleMarkdownContent = "\n# Hello Markdown\n\nWelcome to the **Markdown Editor**!  \nThis editor supports *rich formatting*, _underline_, ~~strikethrough~~ and more.\n\n---\n\n## \uD83D\uDD17 Links\nCheck out [Elseware Games](https://elseware.games) \u2014 your source for game tools.\n\n---\n\n## \uD83D\uDCF7 Images\n![Example Image](https://via.placeholder.com/150)\n\n---\n\n## \uD83D\uDD22 Lists\n\n### - Unordered List\n- Item one\n- Item two\n  - Nested item\n- Item three\n\n### 1. Ordered List\n1. First\n2. Second\n3. Third\n\n### \u2705 Task List\n- [x] Task completed\n- [ ] Task pending\n- [ ] Another task\n\n---\n\n## \uD83D\uDCE6 Blockquote\n> \"Great software is built, not bought.\"\n\n---\n\n## \uD83D\uDCCA Table\n\n| Feature       | Supported |\n| ------------- | --------- |\n| Headings      | \u2705        |\n| Lists         | \u2705        |\n| Links         | \u2705        |\n| Tables        | \u2705        |\n| Images        | \u2705        |\n| Quotes        | \u2705        |\n| Thematic Line | \u2705        |\n\n---\n\n## \uD83D\uDC4B Final Words\n\nHappy editing with **Markdown Editor**!\n";