@mantis-core/ui 0.5.0 → 0.7.0

package/docs/components/select.md

@@ -1,28 +0,0 @@
----
-name: Select
-category: forms
-import: '@mantis-core/ui/components/Forms/Select'
-whenToUse: Single-value searchable select (react-select); supports creatable mode.
-baseLibrary: react-select
-formContract: ControllerProps
-requiredStyles: [scss/select.scss]
-relatedComponents: [FormFieldRender, AsyncSelect, DropDown]
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true }
-  - { name: options, type: OptionsOrGroups, required: false }
-  - { name: isCreatable, type: boolean, required: false, default: 'false' }
-  - { name: variant, type: ButtonVariant, required: false, default: '''primary''' }
-  - { name: block, type: boolean, required: false }
-  - { name: isLoading, type: boolean, required: false }
----
-## Example
-
-```tsx
-<Select controller={{ name: 'status' }} options={statusOptions} block />
-```
-
-## Notes
-
-- This is not PrimeReact.
-- Keep `classNamePrefix="react-select"` behavior so the shared SCSS continues to match.

package/docs/components/switch.md

@@ -1,24 +0,0 @@
----
-name: Switch
-category: forms
-import: '@mantis-core/ui/components/Forms/Switch'
-whenToUse: Toggle/boolean switch wired to react-hook-form.
-baseLibrary: custom
-formContract: ControllerProps
-requiredStyles: [scss/switch.scss]
-relatedComponents: [FormFieldRender, Toggle]
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true }
-  - { name: label, type: string, required: false }
-  - { name: block, type: boolean, required: false }
----
-## Example
-
-```tsx
-<Switch controller={{ name: 'isActive' }} label='Active' />
-```
-
-## Notes
-
-- This is not PrimeReact `InputSwitch`.

package/docs/components/text-input.md

@@ -1,24 +0,0 @@
----
-name: TextInput
-category: forms
-import: '@mantis-core/ui/components/Forms/TextInput'
-whenToUse: Single-line text field wired to react-hook-form.
-baseLibrary: primereact/inputtext
-formContract: ControllerProps
-requiredStyles: [scss/inputs.scss]
-relatedComponents: [FormFieldRender, TextArea]
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true }
-  - { name: block, type: boolean, required: false, default: 'false' }
-  - { name: defaultValue, type: string, required: false, default: '''''' }
----
-## Example
-
-```tsx
-<TextInput controller={{ name: 'email', rules: { required: true } }} block />
-```
-
-## Notes
-
-- Use this when you want PrimeReact `InputText` behavior with `react-hook-form` wiring.

package/docs/components/time-picker.md

@@ -1,25 +0,0 @@
----
-name: TimePicker
-category: forms
-import: '@mantis-core/ui/components/Forms/TimePicker'
-whenToUse: Time-only picker (15-min intervals) wired to react-hook-form; renders as a styled InputText trigger.
-baseLibrary: react-datepicker
-formContract: ControllerProps
-requiredStyles: [scss/inputs.scss]
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true, description: 'react-hook-form controller config' }
-  - { name: block, type: boolean, required: false, default: 'false', description: 'Expand to full width' }
-  - { name: datePicker, type: DatePickerProps, required: false, description: 'Passthrough props for react-datepicker' }
-  - { name: className, type: string, required: false, description: 'Additional CSS class on the DatePicker wrapper' }
-  - { name: timePeriod, type: '''AM'' | ''PM''', required: false, description: 'Default time period hint' }
----
-## Example
-
-```tsx
-{/* TODO: add example */}
-```
-
-## Notes
-
-- This is not PrimeReact `Calendar`.

package/docs/components/toggle.md

@@ -1,24 +0,0 @@
----
-name: Toggle
-category: forms
-import: '@mantis-core/ui/components/Forms/Toggle'
-whenToUse: Checkbox-based boolean toggle wired to react-hook-form with configurable on/off labels.
-baseLibrary: primereact/checkbox
-formContract: ControllerProps
-relatedComponents: [FormFieldRender, Switch]
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true, description: 'react-hook-form controller config (name, rules, defaultValue)' }
-  - { name: on, type: 'string | any', required: false, default: '''SI''', description: 'Label shown when value is true' }
-  - { name: off, type: 'string | any', required: false, default: '''NO''', description: 'Label shown when value is false' }
-  - { name: size, type: '''sm'' | ''lg'' | ''md''', required: false, description: 'Visual size variant' }
-  - { name: offstyle, type: '''primary'' | ''secondary'' | ''dark''', required: false, description: 'Style when off' }
-  - { name: onstyle, type: '''primary'' | ''secondary'' | ''dark''', required: false, description: 'Style when on' }
-  - { name: onClick, type: any, required: false, description: 'Click handler passthrough' }
-  - { name: active, type: boolean, required: false, description: 'Controlled active state' }
----
-## Example
-
-```tsx
-{/* TODO: add example */}
-```

package/docs/contracts/component-doc-schema.md

@@ -1,78 +0,0 @@
-# Component Doc Schema
-
-Single source of truth for each component in `@mantis-core/ui`. One file per component at
-`docs/components/<kebab-name>.md`. The file has **YAML frontmatter** (machine data) plus a short
-prose body (`## Example`, optional `## Notes`).
-
-`catalog.json`, `COMPONENTS.md`, `llms.txt`, `docs/contracts/dependency-map.md`, and
-`docs/contracts/style-imports.md` are **generated** from these files by `pnpm gen:catalog` — never
-edit them by hand. To document a component, edit its `.md` here and re-run the generator.
-
-## File shape
-
-```md
----
-name: TextInput
-category: forms
-import: '@mantis-core/ui/components/Forms/TextInput'
-whenToUse: Single-line text field wired to react-hook-form.
-baseLibrary: primereact/inputtext
-formContract: ControllerProps
-requiredStyles: ['scss/inputs.scss']
-relatedComponents: ['FormFieldRender', 'TextArea']
-relatedNextCore: []
-props:
-  - { name: controller, type: ControllerProps, required: true }
-  - { name: block, type: boolean, required: false, default: false }
-  - { name: defaultValue, type: string, required: false, default: "''" }
----
-
-## Example
-
-```tsx
-<TextInput controller={{ name: 'title' }} block />
-```
-
-## Notes
-
-- Optional prose. Gotchas, variants, edge cases. Keep terse — LLM-optimized, no over-info.
-```
-
-## Frontmatter fields
-
-| Field | Type | Required | Notes |
-|---|---|---|---|
-| `name` | string | ✅ | Component identifier, PascalCase. Matches the export. |
-| `category` | string | ✅ | One of: `forms`, `tables`, `pages`, `maps`, `overlays`, `navigation`, `data`, `feedback`, `auth`, `buttons`, `charts`. Groups `catalog.json`. |
-| `import` | string | ✅¹ | **Deep path**, verbatim into `catalog.json.import`. Form `@mantis-core/ui/components/<Area>/<Name>`. Exceptions exist (`.../components/table-toolbar`, `.../components/table-filter-field`) — store the real path, do not derive it. ¹Omit **only** for overview/guide docs (e.g. `admin-page-layout.md`): an `import`-less file ships but is excluded from `catalog.json` and `llms.txt`. |
-| `whenToUse` | string | ✅ | One line. Drives `catalog.json.whenToUse` + the `llms.txt` index. |
-| `baseLibrary` | string | ➖ | Underlying lib (`primereact/inputtext`, `react-select`, `custom`). Drives `dependency-map.md`. Use `custom` for components with no third-party base. |
-| `formContract` | string | ➖ | Shared contract the component follows, e.g. `ControllerProps`. Omit if none. |
-| `requiredStyles` | string[] | ➖ | SCSS partials from `@mantis-core/styles`, e.g. `['scss/inputs.scss']`. Drives `style-imports.md`. Empty/omit when the component uses only utility classes or inline styles. |
-| `relatedComponents` | string[] | ➖ | Sibling component `name`s. Cross-reference for LLMs. |
-| `relatedNextCore` | string[] | ➖ | Hooks/utils from `@mantis-core/next-core` it pairs with, e.g. `['useList']`. Empty for stateless components. |
-| `props` | object[] | ✅ | Each: `{ name, type, required, default?, description? }`. `name`/`type` strings, `required` boolean, `default`/`description` optional strings. Maps 1:1 to `catalog.json.props[]`. Empty array `[]` for components with no documented props (factories, etc.). |
-
-## Body
-
-- `## Example` — **enforced**: if the `## Example` heading is present it MUST contain exactly one fenced
-  ```tsx block (closing fence on its own line) — the generator throws otherwise. The code inside is
-  extracted verbatim into `catalog.json.example`. Keep it copy-pasteable. Use the heading `## Example`
-  (singular); `## Examples` is not recognized. Avoid an inline ``` inside the snippet.
-- `## Notes` — optional prose. Not consumed by the generator beyond shipping in the `.md`.
-
-## Generated outputs (do not hand-edit)
-
-| Output | Built from |
-|---|---|
-| `catalog.json` | All frontmatter, grouped by `category`. Shape: `{ name, import, whenToUse, props, example, category }`. |
-| `COMPONENTS.md` | Index linking every `docs/components/*.md`. |
-| `llms.txt` | LLM entry-point: `name · whenToUse · import · link`, grouped by category. |
-| `docs/contracts/dependency-map.md` | `name → baseLibrary`, sectioned PrimeReact / non-PrimeReact / custom. |
-| `docs/contracts/style-imports.md` | `name → requiredStyles`, plus the consolidated `@use` block. |
-
-## Hand-maintained (not generated)
-
-- `docs/contracts/controller-props.md` — shared contract, not derivable from one component.
-- `docs/README.md`, `README.md` — narrative docs.
-- Each component's `## Notes` prose.

package/docs/contracts/controller-props.md

@@ -1,28 +0,0 @@
-# Controller Props
-
-Shared form wrappers in `@mantis-core/ui` use this contract:
-
-```ts
-export interface ControllerProps {
-  name: string;
-  rules?: RegisterOptions;
-  shouldUnregister?: boolean;
-  defaultValue?: any;
-  control?: Control;
-}
-```
-
-## Usage
-
-```tsx
-controller={{
-  name: "title",
-  control: form.control,
-  rules: { required: "Title is required" },
-}}
-```
-
-## Notes
-
-- Components that expose `controller: ControllerProps` are designed for `react-hook-form`.
-- Some components, such as `FileDropzone`, also support plain controlled mode without `controller`.