@oddkin/components 0.0.0-stage → 1.0.0-beta.1

package/schemas/composition/odd-avatar.v1.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-avatar.v1.json",
+  "title": "odd-avatar",
+  "description": "A person or group marker: a picture (`src`) or, without one or when it fails to load, the initials of `label`. Content placed inside replaces the initials (a \"+3\" overflow count).",
+  "$comment": "Slots: default. A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-avatar"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "The person's or group's name; names the image.",
+          "default": ""
+        },
+        "src": {
+          "type": "string",
+          "format": "uri-reference",
+          "pattern": "^(?![\\u0000-\\u0020]*(?:[jJ]\\s*[aA]\\s*[vV]\\s*[aA]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT]|[vV]\\s*[bB]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT])\\s*:)",
+          "description": "Picture URL; the initials show without it.",
+          "default": ""
+        },
+        "size": {
+          "enum": [
+            "sm",
+            "md",
+            "lg"
+          ],
+          "description": "Diameter: 32, 40, or 48 px.",
+          "default": "md"
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    }
+  }
+}

package/schemas/composition/odd-badge.v1.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-badge.v1.json",
+  "title": "odd-badge",
+  "description": "A passive status or count: words with a tone colour and a glyph, so the meaning never rests on colour alone. Not an action; do not make it clickable.",
+  "$comment": "Slots: default. A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-badge"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "tone": {
+          "enum": [
+            "neutral",
+            "info",
+            "success",
+            "warning",
+            "danger"
+          ],
+          "description": "Meaning colour and glyph.",
+          "default": "neutral"
+        },
+        "no-marker": {
+          "type": "boolean",
+          "description": "Hides the tone glyph, as for a count.",
+          "default": false
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    }
+  }
+}

package/schemas/composition/odd-breadcrumbs.v1.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-breadcrumbs.v1.json",
+  "title": "odd-breadcrumbs",
+  "description": "A location trail: links to the pages above this one, then the current page as text. Items come from `<a href>` descendants (a server-rendered `<ol><li><a href>` list works as written) or the `items` property; with `max-items`, the middle items wait behind a \"more\" button.",
+  "$comment": "Slots: \"home\". A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-breadcrumbs"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Names the navigation; default `strings.label`.",
+          "default": ""
+        },
+        "max-items": {
+          "type": "number",
+          "description": "Collapse when there are more items than this: the first item, a \"more\" button, and the last `max-items − 1` items show. 0 never collapses.",
+          "default": 0
+        }
+      }
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "strings": {
+          "type": "object",
+          "properties": {
+            "label": {
+              "type": "string"
+            },
+            "more": {
+              "type": "string"
+            }
+          },
+          "description": "Localized string overrides."
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    }
+  }
+}

package/schemas/composition/odd-button.v1.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-button.v1.json",
+  "title": "odd-button",
+  "description": "A button for actions. Renders a native `<button>` in its shadow root, so keyboard activation, focus, and accessible naming come from the platform.",
+  "$comment": "Slots: default, \"end\", \"start\". A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-button"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "appearance": {
+          "enum": [
+            "primary",
+            "secondary",
+            "ghost"
+          ],
+          "description": "Visual emphasis.",
+          "default": "secondary"
+        },
+        "size": {
+          "enum": [
+            "sm",
+            "md",
+            "lg"
+          ],
+          "description": "Size.",
+          "default": "md"
+        },
+        "type": {
+          "enum": [
+            "button",
+            "submit",
+            "reset"
+          ],
+          "description": "Form behavior, as on a native button.",
+          "default": "button"
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Prevents interaction and focus.",
+          "default": false
+        },
+        "loading": {
+          "type": "boolean",
+          "description": "Shows a spinner and ignores activation; the button stays focusable.",
+          "default": false
+        },
+        "full-width": {
+          "type": "boolean",
+          "description": "Fills the inline size of its container.",
+          "default": false
+        },
+        "toggle": {
+          "type": "boolean",
+          "description": "Keeps a pressed state that each activation flips (`aria-pressed`).",
+          "default": false
+        },
+        "pressed": {
+          "type": "boolean",
+          "description": "Whether a `toggle` button is pressed.",
+          "default": false
+        },
+        "name": {
+          "type": "string",
+          "description": "Name submitted with the form.",
+          "default": ""
+        },
+        "value": {
+          "type": "string",
+          "description": "Value submitted with the form.",
+          "default": ""
+        },
+        "formaction": {
+          "type": "string",
+          "format": "uri-reference",
+          "pattern": "^(?![\\u0000-\\u0020]*(?:[jJ]\\s*[aA]\\s*[vV]\\s*[aA]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT]|[vV]\\s*[bB]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT])\\s*:)",
+          "description": "URL this button submits to instead of the form's `action`."
+        },
+        "formmethod": {
+          "type": "string",
+          "description": "Method (`get`, `post`, `dialog`) this button submits with instead of the form's."
+        },
+        "formenctype": {
+          "type": "string",
+          "description": "Encoding this button submits with instead of the form's `enctype`."
+        },
+        "formtarget": {
+          "type": "string",
+          "description": "Navigable this button submits to instead of the form's `target`."
+        },
+        "formnovalidate": {
+          "type": "boolean",
+          "description": "Submits without constraint validation.",
+          "default": false
+        },
+        "label": {
+          "type": "string",
+          "description": "Accessible name when the content has no text (icon-only buttons).",
+          "default": ""
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    },
+    "actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "change": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        },
+        "click": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        },
+        "input": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        }
+      }
+    }
+  }
+}

package/schemas/composition/odd-calendar.v1.json

@@ -0,0 +1,122 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-calendar.v1.json",
+  "title": "odd-calendar",
+  "description": "A month of dates to choose one from: the WAI-ARIA date grid, with the month and buttons to the months before and after above it, and Today and Clear below. The value is a `YYYY-MM-DD` date, submitted under `name` as a native date input submits it. Weeks start on the page language's first day (`first-day` sets it); names come from `Intl.DateTimeFormat`.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-calendar"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name submitted with the form. Reflected: a form-associated element submits under its name attribute."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Prevents interaction and submission.",
+          "default": false
+        },
+        "description": {
+          "type": "string",
+          "description": "Help text below the label.",
+          "default": ""
+        },
+        "error": {
+          "type": "string",
+          "description": "Error message; marks the field invalid (custom validity) while set.",
+          "default": ""
+        },
+        "label": {
+          "type": "string",
+          "description": "Visible label; names the calendar.",
+          "default": ""
+        },
+        "value": {
+          "type": "string",
+          "description": "Initial date, `YYYY-MM-DD`; the `value` attribute, as on a native date input.",
+          "default": ""
+        },
+        "min": {
+          "type": "string",
+          "description": "Earliest date that can be chosen, `YYYY-MM-DD`.",
+          "default": ""
+        },
+        "max": {
+          "type": "string",
+          "description": "Latest date that can be chosen, `YYYY-MM-DD`.",
+          "default": ""
+        },
+        "required": {
+          "type": "boolean",
+          "description": "A date is required to submit.",
+          "default": false
+        },
+        "readonly": {
+          "type": "boolean",
+          "description": "The dates can be moved through but the value cannot change; still submitted, and not validated.",
+          "default": false
+        },
+        "first-day": {
+          "type": "number",
+          "description": "First day of the week, 1 (Monday) to 7 (Sunday) as in `Intl.Locale` week information; 0 follows the page language.",
+          "default": 0
+        }
+      }
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "strings": {
+          "type": "object",
+          "properties": {
+            "previousMonth": {
+              "type": "string"
+            },
+            "nextMonth": {
+              "type": "string"
+            },
+            "today": {
+              "type": "string"
+            },
+            "clear": {
+              "type": "string"
+            }
+          },
+          "description": "Localized string overrides: `previousMonth`, `nextMonth`, `today`, `clear`."
+        },
+        "value": {
+          "type": "string",
+          "description": "The chosen date, `YYYY-MM-DD`, or empty. Setting it detaches it from `defaultValue`."
+        }
+      }
+    },
+    "actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "change": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        },
+        "input": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        }
+      }
+    }
+  }
+}

package/schemas/composition/odd-card.v1.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-card.v1.json",
+  "title": "odd-card",
+  "description": "A surface that groups related content, with optional header and footer.",
+  "$comment": "Slots: default, \"footer\", \"header\". A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-card"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "appearance": {
+          "enum": [
+            "outlined",
+            "filled",
+            "elevated"
+          ],
+          "description": "Surface treatment.",
+          "default": "outlined"
+        },
+        "padding": {
+          "enum": [
+            "none",
+            "sm",
+            "md",
+            "lg"
+          ],
+          "description": "Inner padding step.",
+          "default": "md"
+        },
+        "label": {
+          "type": "string",
+          "description": "Accessible name; makes the card a region.",
+          "default": ""
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    }
+  }
+}

package/schemas/composition/odd-carousel.v1.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-carousel.v1.json",
+  "title": "odd-carousel",
+  "description": "A carousel (APG carousel, manual only): one slide at a time, with previous and next, the position, and a button per slide. It never moves by itself. Each element child is a slide; the element assigns each to a slide group inside its own shadow root (manual slot assignment), so the content stays in the light DOM.",
+  "$comment": "Slots: default. A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-carousel"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Names the carousel.",
+          "default": ""
+        },
+        "current": {
+          "type": "string",
+          "description": "The shown slide's number, from 1 (as odd-pagination's `current`); out of range, the nearest slide shows.",
+          "default": "1"
+        }
+      }
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "strings": {
+          "type": "object",
+          "properties": {
+            "carousel": {
+              "type": "string"
+            },
+            "slide": {
+              "type": "string"
+            },
+            "position": {
+              "type": "string"
+            },
+            "previous": {
+              "type": "string"
+            },
+            "next": {
+              "type": "string"
+            },
+            "picker": {
+              "type": "string"
+            },
+            "goTo": {
+              "type": "string"
+            }
+          },
+          "description": "Localized string overrides."
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    },
+    "actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "change": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        },
+        "input": {
+          "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/action"
+        }
+      }
+    }
+  }
+}

package/schemas/composition/odd-checkbox-group.v1.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/composition/odd-checkbox-group.v1.json",
+  "title": "odd-checkbox-group",
+  "description": "A named group of `odd-checkbox` choices with one legend, description, and error. Each choice keeps its own name, value, and checkedness; the group adds `required` (at least one checked) and `disabled` for all of them.",
+  "$comment": "Slots: default. A child names a slot with \"slot\"; text and children without \"slot\" go to the default slot.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "element"
+  ],
+  "properties": {
+    "element": {
+      "const": "odd-checkbox-group"
+    },
+    "id": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/id"
+    },
+    "slot": {
+      "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/slot"
+    },
+    "attributes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name submitted with the form. Reflected: a form-associated element submits under its name attribute."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Prevents interaction and submission.",
+          "default": false
+        },
+        "description": {
+          "type": "string",
+          "description": "Help text below the label.",
+          "default": ""
+        },
+        "error": {
+          "type": "string",
+          "description": "Error message; marks the field invalid (custom validity) while set.",
+          "default": ""
+        },
+        "label": {
+          "type": "string",
+          "description": "Visible legend; names the group.",
+          "default": ""
+        },
+        "required": {
+          "type": "boolean",
+          "description": "At least one choice must be checked to submit.",
+          "default": false
+        },
+        "orientation": {
+          "enum": [
+            "vertical",
+            "horizontal"
+          ],
+          "description": "Stacks the choices, or lines them up and wraps them.",
+          "default": "vertical"
+        }
+      }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://oddkin.dev/schemas/composition/composition.v1.json#/$defs/node"
+      }
+    }
+  }
+}