@jitl/opentui-solid 0.1.97-next.130245d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +193 -0
- package/dist/index.d.ts +160 -0
- package/index.d.ts +19 -0
- package/index.js +1251 -0
- package/jsx-runtime.d.ts +51 -0
- package/package.json +54 -0
- package/scripts/preload.ts +3 -0
- package/scripts/runtime-plugin-support.d.ts +1 -0
- package/scripts/runtime-plugin-support.ts +59 -0
- package/scripts/solid-plugin.d.ts +11 -0
- package/scripts/solid-plugin.ts +148 -0
- package/src/elements/extras.d.ts +41 -0
- package/src/elements/hooks.d.ts +38 -0
- package/src/elements/index.d.ts +72 -0
- package/src/elements/slot.d.ts +38 -0
- package/src/plugins/slot.d.ts +25 -0
- package/src/reconciler.d.ts +5 -0
- package/src/renderer/index.d.ts +3 -0
- package/src/renderer/universal.d.ts +29 -0
- package/src/time-to-first-draw.d.ts +9 -0
- package/src/types/elements.d.ts +91 -0
- package/src/utils/id-counter.d.ts +1 -0
- package/src/utils/log.d.ts +1 -0
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import type { ASCIIFontOptions, ASCIIFontRenderable, BaseRenderable, BoxOptions, BoxRenderable, CodeOptions, CodeRenderable, InputRenderable, InputRenderableOptions, KeyEvent, MarkdownOptions, MarkdownRenderable, RenderableOptions, RenderContext, ScrollBoxOptions, ScrollBoxRenderable, SelectOption, SelectRenderable, SelectRenderableOptions, TabSelectOption, TabSelectRenderable, TabSelectRenderableOptions, TextareaOptions, TextareaRenderable, TextNodeRenderable, TextOptions, TextRenderable } from "@jitl/opentui-core";
|
|
2
|
+
import type { Ref } from "solid-js";
|
|
3
|
+
import type { JSX } from "../../jsx-runtime";
|
|
4
|
+
/** Properties that should not be included in the style prop */
|
|
5
|
+
export type NonStyledProps = "id" | "buffered" | "live" | "enableLayout" | "selectable" | "renderAfter" | "renderBefore" | `on${string}`;
|
|
6
|
+
/** Solid-specific props for all components */
|
|
7
|
+
export type ElementProps<TRenderable = unknown> = {
|
|
8
|
+
ref?: Ref<TRenderable>;
|
|
9
|
+
};
|
|
10
|
+
/** Base type for any renderable constructor */
|
|
11
|
+
export type RenderableConstructor<TRenderable extends BaseRenderable = BaseRenderable> = new (ctx: RenderContext, options: any) => TRenderable;
|
|
12
|
+
/** Extract the options type from a renderable constructor */
|
|
13
|
+
type ExtractRenderableOptions<TConstructor> = TConstructor extends new (ctx: RenderContext, options: infer TOptions) => any ? TOptions : never;
|
|
14
|
+
/** Extract the renderable type from a constructor */
|
|
15
|
+
type ExtractRenderable<TConstructor> = TConstructor extends new (ctx: RenderContext, options: any) => infer TRenderable ? TRenderable : never;
|
|
16
|
+
/** Determine which properties should be excluded from styling for different renderable types */
|
|
17
|
+
export type GetNonStyledProperties<TConstructor> = TConstructor extends RenderableConstructor<TextRenderable> ? NonStyledProps | "content" : TConstructor extends RenderableConstructor<BoxRenderable> ? NonStyledProps | "title" | "bottomTitle" : TConstructor extends RenderableConstructor<ASCIIFontRenderable> ? NonStyledProps | "text" | "selectable" : TConstructor extends RenderableConstructor<InputRenderable> ? NonStyledProps | "placeholder" | "value" : TConstructor extends RenderableConstructor<CodeRenderable> ? NonStyledProps | "content" | "filetype" | "syntaxStyle" | "treeSitterClient" : TConstructor extends RenderableConstructor<MarkdownRenderable> ? NonStyledProps | "content" | "syntaxStyle" | "treeSitterClient" | "conceal" | "renderNode" : NonStyledProps;
|
|
18
|
+
/** Base props for container components that accept children */
|
|
19
|
+
type ContainerProps<TOptions> = TOptions & {
|
|
20
|
+
children?: JSX.Element;
|
|
21
|
+
};
|
|
22
|
+
/** Smart component props that automatically determine excluded properties */
|
|
23
|
+
type ComponentProps<TOptions extends RenderableOptions<TRenderable>, TRenderable extends BaseRenderable> = TOptions & {
|
|
24
|
+
style?: Partial<Omit<TOptions, GetNonStyledProperties<RenderableConstructor<TRenderable>>>>;
|
|
25
|
+
} & ElementProps<TRenderable>;
|
|
26
|
+
/** Valid text content types for Text component children */
|
|
27
|
+
type TextChildren = string | number | boolean | null | undefined | JSX.Element;
|
|
28
|
+
export type TextProps = ComponentProps<TextOptions, TextRenderable> & {
|
|
29
|
+
children?: TextChildren | Array<TextChildren>;
|
|
30
|
+
};
|
|
31
|
+
export type SpanProps = ComponentProps<{}, TextNodeRenderable> & {
|
|
32
|
+
children?: TextChildren | Array<TextChildren>;
|
|
33
|
+
};
|
|
34
|
+
export type LinkProps = SpanProps & {
|
|
35
|
+
href: string;
|
|
36
|
+
};
|
|
37
|
+
export type BoxProps = ComponentProps<ContainerProps<BoxOptions>, BoxRenderable> & {
|
|
38
|
+
focused?: boolean;
|
|
39
|
+
};
|
|
40
|
+
export type InputProps = ComponentProps<InputRenderableOptions, InputRenderable> & {
|
|
41
|
+
focused?: boolean;
|
|
42
|
+
onInput?: (value: string) => void;
|
|
43
|
+
onChange?: (value: string) => void;
|
|
44
|
+
onSubmit?: (value: string) => void;
|
|
45
|
+
};
|
|
46
|
+
export type TextareaProps = ComponentProps<TextareaOptions, TextareaRenderable> & {
|
|
47
|
+
focused?: boolean;
|
|
48
|
+
onSubmit?: () => void;
|
|
49
|
+
onContentChange?: (value: string) => void;
|
|
50
|
+
onCursorChange?: (value: {
|
|
51
|
+
line: number;
|
|
52
|
+
visualColumn: number;
|
|
53
|
+
}) => void;
|
|
54
|
+
onKeyDown?: (event: KeyEvent) => void;
|
|
55
|
+
onKeyPress?: (event: KeyEvent) => void;
|
|
56
|
+
};
|
|
57
|
+
export type SelectProps = ComponentProps<SelectRenderableOptions, SelectRenderable> & {
|
|
58
|
+
focused?: boolean;
|
|
59
|
+
onChange?: (index: number, option: SelectOption | null) => void;
|
|
60
|
+
onSelect?: (index: number, option: SelectOption | null) => void;
|
|
61
|
+
};
|
|
62
|
+
export type AsciiFontProps = ComponentProps<ASCIIFontOptions, ASCIIFontRenderable>;
|
|
63
|
+
export type TabSelectProps = ComponentProps<TabSelectRenderableOptions, TabSelectRenderable> & {
|
|
64
|
+
focused?: boolean;
|
|
65
|
+
onChange?: (index: number, option: TabSelectOption | null) => void;
|
|
66
|
+
onSelect?: (index: number, option: TabSelectOption | null) => void;
|
|
67
|
+
};
|
|
68
|
+
export type ScrollBoxProps = ComponentProps<ContainerProps<ScrollBoxOptions>, ScrollBoxRenderable> & {
|
|
69
|
+
focused?: boolean;
|
|
70
|
+
stickyScroll?: boolean;
|
|
71
|
+
stickyStart?: "bottom" | "top" | "left" | "right";
|
|
72
|
+
};
|
|
73
|
+
export type CodeProps = ComponentProps<CodeOptions, CodeRenderable>;
|
|
74
|
+
export type MarkdownProps = ComponentProps<MarkdownOptions, MarkdownRenderable>;
|
|
75
|
+
/** Convert renderable constructor to component props with proper style exclusions */
|
|
76
|
+
export type ExtendedComponentProps<TConstructor extends RenderableConstructor, TOptions = ExtractRenderableOptions<TConstructor>> = TOptions & {
|
|
77
|
+
children?: JSX.Element;
|
|
78
|
+
style?: Partial<Omit<TOptions, GetNonStyledProperties<TConstructor>>>;
|
|
79
|
+
} & ElementProps<ExtractRenderable<TConstructor>>;
|
|
80
|
+
/** Helper type to create JSX element properties from a component catalogue */
|
|
81
|
+
export type ExtendedIntrinsicElements<TComponentCatalogue extends Record<string, RenderableConstructor>> = {
|
|
82
|
+
[TComponentName in keyof TComponentCatalogue]: ExtendedComponentProps<TComponentCatalogue[TComponentName]>;
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* Global augmentation interface for extended components
|
|
86
|
+
* This will be augmented by user code using module augmentation
|
|
87
|
+
*/
|
|
88
|
+
export interface OpenTUIComponents {
|
|
89
|
+
[componentName: string]: RenderableConstructor;
|
|
90
|
+
}
|
|
91
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function getNextId(elementType: string): string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const log: (...args: any[]) => void;
|