@alchemy.run/sigil 0.0.0-alpha.4 → 0.0.0-alpha.6

package/README.md

@@ -11,10 +11,24 @@
 - **Self-contained**: the only runtime dependencies are `react-reconciler` and `scheduler`. Everything else — the ANSI/terminal subsystem (`src/ansi/`), styling, width measurement, wrapping — is first-class TypeScript in this repository.
 - **Integrated layout engine**: layout is computed by a TypeScript port of [Yoga](https://github.com/facebook/yoga) (`src/yoga/`) instead of the Yoga WASM binary, continuously verified against an f64-patched reference Yoga build via differential fuzzing.
 - **Modern toolchain**: built with [Vite+](https://viteplus.dev) (Vitest, Oxlint, Oxfmt, tsdown) and TypeScript 7.
+- **Structured terminal core**: cells retain semantic colors, gradients, links, and graphemes through layout and composition, then serialize for the target terminal profile.
+
+Low-level integrations are available through focused `ansi`, `capabilities`, `color`, `router`, `screen`, `terminal`, and `yoga` subpaths. See the [architecture guide](docs/architecture.md), [API stability policy](docs/api-stability.md), [color semantics](docs/color-semantics.md), and [performance notes](docs/performance.md).
 
 Upstream Ink and Yoga are tracked as submodules in `.vendor/` — upstream's test suites run against this codebase as part of the regular test run. See `THIRD_PARTY_NOTICES.md` for attribution.
 
-The documentation below is inherited from Ink; the API is unchanged apart from imports
+The familiar Ink component and hook surface remains available from the package root. Sigil also adds terminal-aware APIs described below. The longer API reference is inherited from Ink and uses Sigil imports where applicable.
+
+## Sigil extensions
+
+- **Structured rendering** — layout produces a semantic `Screen` of grapheme-aware cells before terminal-specific ANSI serialization. Import low-level primitives from `@alchemy.run/sigil/screen`, `@alchemy.run/sigil/color`, and `@alchemy.run/sigil/terminal`.
+- **Terminal capabilities** — `getCapabilities()` returns the current snapshot, while `capabilities.subscribe()` and `useCapabilitiesChange()` observe live terminal reports. The framework-free API is available from `@alchemy.run/sigil/capabilities`.
+- **Terminal integrations** — `<Hyperlink>` provides OSC 8 links with a fallback. `useTitle`, `useWorkingDirectory`, `useProgress`, `useNotification`, `useClipboard`, and `usePointerShape` manage session-scoped OSC state.
+- **ANSI-aware text** — `<AnsiText>` interprets ANSI-styled input without flattening its semantic colors before rendering.
+- **Routing** — `@alchemy.run/sigil/router` provides an in-memory router designed for terminal applications. See the [routing recipe](recipes/routing.md).
+- **Testing** — the repository includes an internal emulator-backed E2E harness and interactive explorer. These utilities are not part of the public API while their design is evolving.
+
+Sigil requires Node.js 22 or newer and React 19.2 or newer.
 
 ---
 
@@ -1363,6 +1377,8 @@ Accepts the same values as [`color`](#color) in the `<Text>` component.
 
 The background color fills the entire `<Box>` area and is inherited by child `<Text>` components unless they specify their own `backgroundColor`.
 
+Use `backgroundColor=""` to paint the box with explicit blank cells on the terminal's default background. This is useful for opaque compositor layers: lower-layer glyphs are erased without assuming what color the user's terminal background is. Omitting `backgroundColor` keeps the box transparent.
+
 ```jsx
 <Box backgroundColor="blue" alignSelf="flex-start">
   <Text>Blue inherited </Text>
@@ -2661,14 +2677,6 @@ This controls how frequently the UI can update to prevent excessive re-rendering
 Higher values allow more frequent updates but may impact performance.
 Setting it to a lower value may be useful for components that update very frequently, to reduce CPU usage.
 
-###### incrementalRendering
-
-Type: `boolean`\
-Default: `false`
-
-Enable incremental rendering mode which only updates changed lines instead of redrawing the entire output.
-This can reduce flickering and improve performance for frequently updating UIs.
-
 ###### concurrent
 
 Type: `boolean`\
@@ -3166,6 +3174,10 @@ npm run example examples/[example name]
 - [Static](examples/static/static.tsx) - Use the `<Static>` component to render permanent output.
 - [Child process](examples/subprocess-output) - Renders output from a child process.
 - [Router](examples/router/router.tsx) - Navigate between routes using React Router's `MemoryRouter`.
+- [Charm brightness](examples/charm-brightness/brightness.tsx) - A native port of Lip Gloss's progressive lightening and darkening demo.
+- [Charm canvas](examples/charm-canvas/canvas.tsx) - Layered fields and gradient-bordered cards inspired by Lip Gloss's compositor demo.
+- [Charm layout](examples/charm-layout/layout.tsx) - The Lip Gloss layout showcase rebuilt with React, Yoga, gradients, and compositing.
+- [Charm profile](examples/charm-profile/profile.tsx) - The Lip Gloss SSH profile showcase adapted to Sigil's stream-scoped terminal capabilities.
 
 ## Continuous Integration
 

package/THIRD_PARTY_NOTICES.md

@@ -9,6 +9,15 @@ specific origin of each file.
 The core of this project is a fork of [Ink](https://github.com/vadimdemedes/ink).
 Copyright (c) Vadym Demedes. See the root `LICENSE` file.
 
+## Lip Gloss examples
+
+The examples under `examples/charm-*` are ports or adaptations of visual demos
+from [Charmbracelet Lip Gloss](https://github.com/charmbracelet/lipgloss).
+
+Copyright (c) 2020-2026 Charmbracelet, Inc.
+
+Licensed under the MIT License (text below).
+
 ## Yoga
 
 The layout engine (`src/yoga/`) is a TypeScript port of
@@ -53,7 +62,7 @@ Licensed under the MIT License (text above).
 
 ## supports-color (MIT)
 
-`src/ansi/supports-color.ts` is derived from `supports-color`.
+The color-level detection in `src/capabilities/detect.ts` is derived from `supports-color`.
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 and Josh Junon.
@@ -141,3 +150,32 @@ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
+
+## react-router (MIT)
+
+The route matching engine and component model of `src/router/` are ported from
+[react-router](https://github.com/remix-run/react-router)'s declarative mode.
+
+Copyright (c) React Training LLC 2015-2019, Remix Software Inc. 2020-2021,
+and Shopify Inc. 2022-2023.
+
+Licensed under the MIT License (text above).
+
+## supports-hyperlinks (MIT)
+
+The hyperlink detection in `src/capabilities/detect.ts` is derived from
+`supports-hyperlinks`.
+
+Copyright (c) James Talmage <james@talmage.io> (https://github.com/jamestalmage)
+and Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Licensed under the MIT License (text above).
+
+## is-unicode-supported (MIT)
+
+`detectUnicodeSupport` in `src/capabilities/detect.ts` is derived from
+`is-unicode-supported`.
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Licensed under the MIT License (text above).

package/dist/Text-BobFKi74.d.ts

@@ -0,0 +1,452 @@
+import { s as Paint } from "./paint-C19minOS.js";
+import { ReactNode } from "react";
+//#region src/glyphs.d.ts
+declare const BOXES: {
+  readonly single: {
+    readonly topLeft: "┌";
+    readonly top: "─";
+    readonly topRight: "┐";
+    readonly right: "│";
+    readonly bottomRight: "┘";
+    readonly bottom: "─";
+    readonly bottomLeft: "└";
+    readonly left: "│";
+  };
+  readonly double: {
+    readonly topLeft: "╔";
+    readonly top: "═";
+    readonly topRight: "╗";
+    readonly right: "║";
+    readonly bottomRight: "╝";
+    readonly bottom: "═";
+    readonly bottomLeft: "╚";
+    readonly left: "║";
+  };
+  readonly round: {
+    readonly topLeft: "╭";
+    readonly top: "─";
+    readonly topRight: "╮";
+    readonly right: "│";
+    readonly bottomRight: "╯";
+    readonly bottom: "─";
+    readonly bottomLeft: "╰";
+    readonly left: "│";
+  };
+  readonly bold: {
+    readonly topLeft: "┏";
+    readonly top: "━";
+    readonly topRight: "┓";
+    readonly right: "┃";
+    readonly bottomRight: "┛";
+    readonly bottom: "━";
+    readonly bottomLeft: "┗";
+    readonly left: "┃";
+  };
+  readonly singleDouble: {
+    readonly topLeft: "╓";
+    readonly top: "─";
+    readonly topRight: "╖";
+    readonly right: "║";
+    readonly bottomRight: "╜";
+    readonly bottom: "─";
+    readonly bottomLeft: "╙";
+    readonly left: "║";
+  };
+  readonly doubleSingle: {
+    readonly topLeft: "╒";
+    readonly top: "═";
+    readonly topRight: "╕";
+    readonly right: "│";
+    readonly bottomRight: "╛";
+    readonly bottom: "═";
+    readonly bottomLeft: "╘";
+    readonly left: "│";
+  };
+  readonly classic: {
+    readonly topLeft: "+";
+    readonly top: "-";
+    readonly topRight: "+";
+    readonly right: "|";
+    readonly bottomRight: "+";
+    readonly bottom: "-";
+    readonly bottomLeft: "+";
+    readonly left: "|";
+  };
+  readonly arrow: {
+    readonly topLeft: "↘";
+    readonly top: "↓";
+    readonly topRight: "↙";
+    readonly right: "←";
+    readonly bottomRight: "↖";
+    readonly bottom: "↑";
+    readonly bottomLeft: "↗";
+    readonly left: "→";
+  };
+};
+type BoxStyle = keyof typeof BOXES;
+/**
+The set of glyphs making up a box border, for custom `borderStyle` objects.
+*/
+type BoxGlyphs = {
+  readonly topLeft: string;
+  readonly top: string;
+  readonly topRight: string;
+  readonly right: string;
+  readonly bottomRight: string;
+  readonly bottom: string;
+  readonly bottomLeft: string;
+  readonly left: string;
+};
+//#endregion
+//#region src/styles.d.ts
+type Styles = {
+  readonly textWrap?: "wrap" | "hard" | "truncate-end" | "truncate" | "truncate-middle" | "truncate-start" | "none";
+  /**
+      Controls how the element is positioned.
+  
+      When `position` is `static`, `top`, `right`, `bottom`, and `left` are ignored.
+      */
+  readonly position?: "absolute" | "relative" | "static";
+  /**
+      Top offset for positioned elements.
+      */
+  readonly top?: number | string;
+  /**
+      Right offset for positioned elements.
+      */
+  readonly right?: number | string;
+  /**
+      Bottom offset for positioned elements.
+      */
+  readonly bottom?: number | string;
+  /**
+      Left offset for positioned elements.
+      */
+  readonly left?: number | string;
+  /**
+      Size of the gap between an element's columns.
+      */
+  readonly columnGap?: number;
+  /**
+      Size of the gap between an element's rows.
+      */
+  readonly rowGap?: number;
+  /**
+      Size of the gap between an element's columns and rows. A shorthand for `columnGap` and `rowGap`.
+      */
+  readonly gap?: number;
+  /**
+      Margin on all sides. Equivalent to setting `marginTop`, `marginBottom`, `marginLeft`, and `marginRight`.
+      */
+  readonly margin?: number;
+  /**
+      Horizontal margin. Equivalent to setting `marginLeft` and `marginRight`.
+      */
+  readonly marginX?: number;
+  /**
+      Vertical margin. Equivalent to setting `marginTop` and `marginBottom`.
+      */
+  readonly marginY?: number;
+  /**
+      Top margin.
+      */
+  readonly marginTop?: number;
+  /**
+      Bottom margin.
+      */
+  readonly marginBottom?: number;
+  /**
+      Left margin.
+      */
+  readonly marginLeft?: number;
+  /**
+      Right margin.
+      */
+  readonly marginRight?: number;
+  /**
+      Padding on all sides. Equivalent to setting `paddingTop`, `paddingBottom`, `paddingLeft`, and `paddingRight`.
+      */
+  readonly padding?: number;
+  /**
+      Horizontal padding. Equivalent to setting `paddingLeft` and `paddingRight`.
+      */
+  readonly paddingX?: number;
+  /**
+      Vertical padding. Equivalent to setting `paddingTop` and `paddingBottom`.
+      */
+  readonly paddingY?: number;
+  /**
+      Top padding.
+      */
+  readonly paddingTop?: number;
+  /**
+      Bottom padding.
+      */
+  readonly paddingBottom?: number;
+  /**
+      Left padding.
+      */
+  readonly paddingLeft?: number;
+  /**
+      Right padding.
+      */
+  readonly paddingRight?: number;
+  /**
+      This property defines the ability for a flex item to grow if necessary.
+      See [flex-grow](https://css-tricks.com/almanac/properties/f/flex-grow/).
+      */
+  readonly flexGrow?: number;
+  /**
+      It specifies the “flex shrink factor”, which determines how much the flex item will shrink relative to the rest of the flex items in the flex container when there isn't enough space on the row.
+      See [flex-shrink](https://css-tricks.com/almanac/properties/f/flex-shrink/).
+      */
+  readonly flexShrink?: number;
+  /**
+      It establishes the main-axis, thus defining the direction flex items are placed in the flex container.
+      See [flex-direction](https://css-tricks.com/almanac/properties/f/flex-direction/).
+      */
+  readonly flexDirection?: "row" | "column" | "row-reverse" | "column-reverse";
+  /**
+      It specifies the initial size of the flex item, before any available space is distributed according to the flex factors.
+      See [flex-basis](https://css-tricks.com/almanac/properties/f/flex-basis/).
+      */
+  readonly flexBasis?: number | string;
+  /**
+      It defines whether the flex items are forced in a single line or can be flowed into multiple lines. If set to multiple lines, it also defines the cross-axis which determines the direction new lines are stacked in.
+      See [flex-wrap](https://css-tricks.com/almanac/properties/f/flex-wrap/).
+      */
+  readonly flexWrap?: "nowrap" | "wrap" | "wrap-reverse";
+  /**
+      The align-items property defines the default behavior for how items are laid out along the cross axis (perpendicular to the main axis).
+      See [align-items](https://css-tricks.com/almanac/properties/a/align-items/).
+      */
+  readonly alignItems?: "flex-start" | "center" | "flex-end" | "stretch" | "baseline";
+  /**
+      It makes possible to override the align-items value for specific flex items.
+      See [align-self](https://css-tricks.com/almanac/properties/a/align-self/).
+      */
+  readonly alignSelf?: "flex-start" | "center" | "flex-end" | "auto" | "stretch" | "baseline";
+  /**
+      It defines the alignment along the cross axis when there are multiple lines of flex items (when using flex-wrap).
+      See [align-content](https://css-tricks.com/almanac/properties/a/align-content/).
+      */
+  readonly alignContent?: "flex-start" | "flex-end" | "center" | "stretch" | "space-between" | "space-around" | "space-evenly";
+  /**
+      It defines the alignment along the main axis.
+      See [justify-content](https://css-tricks.com/almanac/properties/j/justify-content/).
+      */
+  readonly justifyContent?: "flex-start" | "flex-end" | "space-between" | "space-around" | "space-evenly" | "center";
+  /**
+      Width of the element in spaces. You can also set it as a percentage, which will calculate the width based on the width of the parent element.
+      */
+  readonly width?: number | string;
+  /**
+      Height of the element in lines (rows). You can also set it as a percentage, which will calculate the height based on the height of the parent element.
+      */
+  readonly height?: number | string;
+  /**
+      Sets a minimum width of the element.
+      Percentages aren't supported yet; see https://github.com/facebook/yoga/issues/872.
+      */
+  readonly minWidth?: number | string;
+  /**
+      Sets a minimum height of the element in lines (rows). You can also set it as a percentage, which will calculate the minimum height based on the height of the parent element.
+      */
+  readonly minHeight?: number | string;
+  /**
+      Sets a maximum width of the element.
+      Percentages aren't supported yet; see https://github.com/facebook/yoga/issues/872.
+      */
+  readonly maxWidth?: number | string;
+  /**
+      Sets a maximum height of the element in lines (rows). You can also set it as a percentage, which will calculate the maximum height based on the height of the parent element.
+      */
+  readonly maxHeight?: number | string;
+  /**
+      Defines the aspect ratio (width/height) for the element.
+  
+      Use it with at least one size constraint (`width`, `height`, `minHeight`, or `maxHeight`) so Ink can derive the missing dimension.
+      */
+  readonly aspectRatio?: number;
+  /**
+      Set this property to `none` to hide the element.
+      */
+  readonly display?: "flex" | "none";
+  /**
+      Add a border with a specified style. If `borderStyle` is `undefined` (the default), no border will be added.
+      */
+  readonly borderStyle?: BoxStyle | BoxGlyphs;
+  /**
+      Determines whether the top border is visible.
+  
+      @default true
+      */
+  readonly borderTop?: boolean;
+  /**
+      Determines whether the bottom border is visible.
+  
+      @default true
+      */
+  readonly borderBottom?: boolean;
+  /**
+      Determines whether the left border is visible.
+  
+      @default true
+      */
+  readonly borderLeft?: boolean;
+  /**
+      Determines whether the right border is visible.
+  
+      @default true
+      */
+  readonly borderRight?: boolean;
+  /**
+      Change border color. A shorthand for setting `borderTopColor`, `borderRightColor`, `borderBottomColor`, and `borderLeftColor`.
+      */
+  readonly borderColor?: Paint;
+  /**
+      Change the top border color. Accepts the same values as `color` in `Text` component.
+      */
+  readonly borderTopColor?: Paint;
+  /**
+      Change the bottom border color. Accepts the same values as `color` in `Text` component.
+      */
+  readonly borderBottomColor?: Paint;
+  /**
+      Change the left border color. Accepts the same values as `color` in `Text` component.
+      */
+  readonly borderLeftColor?: Paint;
+  /**
+      Change the right border color. Accepts the same values as `color` in `Text` component.
+      */
+  readonly borderRightColor?: Paint;
+  /**
+      Dim the border color. A shorthand for setting `borderTopDimColor`, `borderBottomDimColor`, `borderLeftDimColor`, and `borderRightDimColor`.
+  
+      @default false
+      */
+  readonly borderDimColor?: boolean;
+  /**
+      Dim the top border color.
+  
+      @default false
+      */
+  readonly borderTopDimColor?: boolean;
+  /**
+      Dim the bottom border color.
+  
+      @default false
+      */
+  readonly borderBottomDimColor?: boolean;
+  /**
+      Dim the left border color.
+  
+      @default false
+      */
+  readonly borderLeftDimColor?: boolean;
+  /**
+      Dim the right border color.
+  
+      @default false
+      */
+  readonly borderRightDimColor?: boolean;
+  /**
+      Change border background color. A shorthand for setting `borderTopBackgroundColor`, `borderRightBackgroundColor`, `borderBottomBackgroundColor`, and `borderLeftBackgroundColor`.
+      */
+  readonly borderBackgroundColor?: Paint;
+  /**
+      Change top border background color. Accepts the same values as `backgroundColor` in `Text` component.
+      */
+  readonly borderTopBackgroundColor?: Paint;
+  /**
+      Change bottom border background color. Accepts the same values as `backgroundColor` in `Text` component.
+      */
+  readonly borderBottomBackgroundColor?: Paint;
+  /**
+      Change left border background color. Accepts the same values as `backgroundColor` in `Text` component.
+      */
+  readonly borderLeftBackgroundColor?: Paint;
+  /**
+      Change right border background color. Accepts the same values as `backgroundColor` in `Text` component.
+      */
+  readonly borderRightBackgroundColor?: Paint;
+  /**
+      Behavior for an element's overflow in both directions.
+  
+      @default 'visible'
+      */
+  readonly overflow?: "visible" | "hidden";
+  /**
+      Behavior for an element's overflow in the horizontal direction.
+  
+      @default 'visible'
+      */
+  readonly overflowX?: "visible" | "hidden";
+  /**
+      Behavior for an element's overflow in the vertical direction.
+  
+      @default 'visible'
+      */
+  readonly overflowY?: "visible" | "hidden";
+  /**
+      Background color for the element.
+  
+      Accepts the same values as `color` in the `<Text>` component.
+      */
+  readonly backgroundColor?: Paint;
+};
+//#endregion
+//#region src/components/Text.d.ts
+type Props = {
+  /**
+      A label for the element for screen readers.
+      */
+  readonly "aria-label"?: string;
+  /**
+      Hide the element from screen readers.
+      */
+  readonly "aria-hidden"?: boolean;
+  /**
+      Change text color. Ink uses Chalk under the hood, so all its functionality is supported.
+      */
+  readonly color?: Paint;
+  /**
+      Same as `color`, but for the background.
+      */
+  readonly backgroundColor?: Paint;
+  /**
+      Dim the color (make it less bright).
+      */
+  readonly dimColor?: boolean;
+  /**
+      Make the text bold.
+      */
+  readonly bold?: boolean;
+  /**
+      Make the text italic.
+      */
+  readonly italic?: boolean;
+  /**
+      Make the text underlined.
+      */
+  readonly underline?: boolean;
+  /**
+      Make the text crossed out with a line.
+      */
+  readonly strikethrough?: boolean;
+  /**
+      Inverse background and foreground colors.
+      */
+  readonly inverse?: boolean;
+  /**
+      This property tells Ink to wrap or truncate text if its width is larger than the container. If `wrap` is passed (the default), Ink will wrap text and split it into multiple lines. If `hard` is passed, Ink will fill each line to the full column width, breaking words as necessary. If `truncate-*` is passed, Ink will truncate text instead, resulting in one line of text with the rest cut off. If `none` is passed, the text is neither wrapped nor truncated — it overflows the container (and the screen's nominal width), which is intended for log lines committed to scrollback (e.g. inside `<Static>`), not for live regions.
+      */
+  readonly wrap?: Styles["textWrap"];
+  readonly children?: ReactNode;
+};
+/**
+This component can display text and change its style to make it bold, underlined, italic, or strikethrough.
+*/
+declare function Text({ color, backgroundColor, dimColor, bold, italic, underline, strikethrough, inverse, wrap, children, "aria-label": ariaLabel, "aria-hidden": ariaHidden }: Props): import("react").JSX.Element | null;
+//#endregion
+export { Text as n, Styles as r, Props as t };