Yunfei He
26cf40987b
useStdin() returned the full internal StdinContext (8 members incl. the raw-mode
ref-counting primitives acquireRawMode/releaseRawMode, setBracketedPasteMode, and
internal_eventEmitter/internal_exitOnCtrlC). Ink's useStdin() returns only its PublicProps
— { stdin, setRawMode, isRawModeSupported } — keeping the rest on the internal context,
reached via the internal useStdinContext()/inject. Verified against Ink 7.0.4
(src/hooks/use-stdin.ts:10, src/components/StdinContext.ts).
- Narrow useStdin(): UseStdinReturn (the 3 public fields). The full StdinContext stays
internal, reached by useInput/useFocus/usePaste via inject(StdinContextKey) — the runtime
object is unchanged, only the public type narrows (mirrors Ink's type-level narrowing).
- Name every stdio/app composable return type per VueUse's UseXReturn convention and export
them: UseStdinReturn, UseStdoutReturn, UseStderrReturn, UseAppReturn (shapes byte-identical
to Ink's StdinProps/StdoutProps/StderrProps/AppProps). vue-tui reserves XProps for component
props (BoxProps, via ExtractPublicPropTypes), so composable returns use UseXReturn — the
Vue-community-idiomatic name.
- Unify the two pre-existing return types onto the same convention:
AnimationResult → UseAnimationReturn, UseBoxMetricsResult → UseBoxMetricsReturn.
- Type-level test (public-types.test-d.ts) locks the shapes and asserts useStdin()'s public
return excludes the internal members.
- Docs: trim the type-reexport divergence area to genuine divergences (fold
RenderOptions/Instance → MountOptions/TuiApp into createApp; keep DOMElement → TuiNode);
drop the AppProps/StdinProps/StdoutProps/StderrProps "N/A" entry — those Ink names are the
hook return types, now mirrored as UseXReturn (recorded under Framework idioms). Supersedes #77.
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
50 lines
2.2 KiB
TypeScript
50 lines
2.2 KiB
TypeScript
export { createApp, type TuiApp, type MountOptions } from "./render.ts";
|
|
export { renderToString, type RenderToStringOptions } from "./render-to-string.ts";
|
|
|
|
export {
|
|
Box,
|
|
type AriaRole,
|
|
type AriaState,
|
|
type BoxStyle,
|
|
type BoxProps,
|
|
} from "./components/Box.ts";
|
|
export { Text, type TextProps } from "./components/Text.ts";
|
|
export { Newline, type NewlineProps } from "./components/Newline.ts";
|
|
export { Spacer } from "./components/Spacer.ts";
|
|
export { Static, type StaticProps } from "./components/Static.ts";
|
|
export { Transform, type TransformProps } from "./components/Transform.ts";
|
|
|
|
export { useApp, type UseAppReturn } from "./composables/useApp.ts";
|
|
export { useInput, type Key, type UseInputOptions } from "./composables/useInput.ts";
|
|
export { usePaste, type UsePasteOptions } from "./composables/usePaste.ts";
|
|
export { useFocus, type UseFocusOptions } from "./composables/useFocus.ts";
|
|
export { useFocusManager } from "./composables/useFocusManager.ts";
|
|
export { useStdin, type UseStdinReturn } from "./composables/useStdin.ts";
|
|
export { useStdout, type UseStdoutReturn } from "./composables/useStdout.ts";
|
|
export { useStderr, type UseStderrReturn } from "./composables/useStderr.ts";
|
|
export { useTerminalSize, useWindowSize, type WindowSize } from "./composables/useTerminalSize.ts";
|
|
export { useCursor, type CursorPosition } from "./composables/useCursor.ts";
|
|
export { useIsScreenReaderEnabled } from "./composables/useIsScreenReaderEnabled.ts";
|
|
export {
|
|
useAnimation,
|
|
type AnimationOptions,
|
|
type UseAnimationReturn,
|
|
} from "./composables/useAnimation.ts";
|
|
export {
|
|
useBoxMetrics,
|
|
measureElement,
|
|
type BoxMetrics,
|
|
type UseBoxMetricsReturn,
|
|
} from "./composables/useBoxMetrics.ts";
|
|
export { renderScreenReaderOutput, type ScreenReaderOptions } from "./paint/screen-reader.ts";
|
|
export type { DevState, DevErrorInfo } from "./hmr.ts";
|
|
export {
|
|
kittyFlags,
|
|
kittyModifiers,
|
|
type KittyKeyboardOptions,
|
|
type KittyFlagName,
|
|
} from "./io/kitty-keyboard.ts";
|
|
// `measureText` / `measureTextNatural` are deliberately NOT re-exported: Ink keeps
|
|
// its `measure-text` module internal, and so do we. They remain internal helpers
|
|
// (yoga.ts uses `measureTextNatural`). See .agents/docs/ink-divergences.md.
|