jsbox-cview 1.6.6 → 1.6.8

package/dist/components/static-preference-listview.d.ts

@@ -0,0 +1,389 @@
+import { Base } from "./base";
+type PreferenceCellTypes = "string" | "number" | "integer" | "stepper" | "boolean" | "slider" | "list" | "tab" | "date" | "info" | "interactive-info" | "link" | "symbol-action" | "action";
+export interface PreferenceSection {
+    title: string;
+    rows: PrefsRow[];
+}
+export type PrefsRow = PrefsRowString | PrefsRowNumber | PrefsRowInteger | PrefsRowStepper | PrefsRowBoolean | PrefsRowSlider | PrefsRowList | PrefsRowTab | PrefsRowDate | PrefsRowInfo | PrefsRowInteractiveInfo | PrefsRowLink | PrefsRowSymbolAction | PrefsRowAction;
+interface PrefsRowBase {
+    type: PreferenceCellTypes;
+    key?: string;
+    title?: string;
+    titleColor?: UIColor;
+    changedEvent?: () => void;
+}
+export interface PrefsRowString extends PrefsRowBase {
+    type: "string";
+    value?: string;
+    placeholder?: string;
+    textColor?: UIColor;
+}
+export interface PrefsRowNumber extends PrefsRowBase {
+    type: "number";
+    value?: number;
+    placeholder?: string;
+    textColor?: UIColor;
+    min?: number;
+    max?: number;
+}
+export interface PrefsRowInteger extends PrefsRowBase {
+    type: "integer";
+    value?: number;
+    placeholder?: string;
+    textColor?: UIColor;
+    min?: number;
+    max?: number;
+}
+export interface PrefsRowStepper extends PrefsRowBase {
+    type: "stepper";
+    value?: number;
+    min?: number;
+    max?: number;
+}
+export interface PrefsRowBoolean extends PrefsRowBase {
+    type: "boolean";
+    value?: boolean;
+    onColor?: UIColor;
+    thumbColor?: UIColor;
+}
+export interface PrefsRowSlider extends PrefsRowBase {
+    type: "slider";
+    value?: number;
+    min?: number;
+    max?: number;
+    decimal?: number;
+    minColor?: UIColor;
+    maxColor?: UIColor;
+    thumbColor?: UIColor;
+}
+export interface PrefsRowList extends PrefsRowBase {
+    type: "list";
+    value?: number;
+    items: string[];
+}
+export interface PrefsRowTab extends PrefsRowBase {
+    type: "tab";
+    value?: number;
+    items: string[];
+}
+export interface PrefsRowDate extends PrefsRowBase {
+    type: "date";
+    value?: Date;
+    min?: Date;
+    max?: Date;
+    mode?: number;
+    interval?: number;
+}
+export interface PrefsRowInfo extends PrefsRowBase {
+    type: "info";
+    value?: string;
+}
+export interface PrefsRowInteractiveInfo extends PrefsRowBase {
+    type: "interactive-info";
+    value?: string;
+    copyable?: boolean;
+}
+export interface PrefsRowLink extends PrefsRowBase {
+    type: "link";
+    value?: string;
+}
+export interface PrefsRowSymbolAction extends PrefsRowBase {
+    type: "symbol-action";
+    symbol?: string;
+    tintColor?: UIColor;
+    contentMode?: number;
+    symbolSize?: JBSize;
+    value?: () => void;
+}
+export interface PrefsRowAction extends PrefsRowBase {
+    type: "action";
+    value?: () => void;
+    destructive?: boolean;
+}
+export declare const selectableTypes: string[];
+export declare const excludedTypes: string[];
+type PreferenceValues = {
+    [key: string]: any;
+};
+type AllCells = StringCell | NumberCell | IntegerCell | StepperCell | BooleanCell | SliderCell | ListCell | TabCell | DateCell | InteractiveInfoCell | InfoCell | LinkCell | SymbolActionCell | ActionCell;
+declare abstract class Cell extends Base<UIView, UiTypes.ViewOptions> {
+    abstract _type: string;
+    _key?: string;
+    _title?: string;
+    _value?: any;
+    _values: PreferenceValues;
+    _titleColor: UIColor;
+    _changedEvent?: () => void;
+    _defineView: () => UiTypes.ViewOptions;
+    constructor({ key, title, value, titleColor, changedEvent, }: {
+        key?: string;
+        title?: string;
+        value?: any;
+        titleColor?: UIColor;
+        changedEvent?: () => void;
+    }, values: PreferenceValues);
+    set value(value: any);
+    get value(): any;
+    get type(): string;
+    get key(): string | undefined;
+    abstract _handleValue(value: any): any;
+    abstract _defineValueView(): UiTypes.AllViewOptions;
+    _defineTitleView(): UiTypes.LabelOptions;
+}
+declare abstract class BaseStringCell extends Cell {
+    abstract _type: string;
+    _placeholder?: string;
+    _textColor?: UIColor;
+    constructor(props: PrefsRowString | PrefsRowNumber | PrefsRowInteger, values: PreferenceValues);
+    _defineValueView(): UiTypes.AllViewOptions;
+    _handleValue(text: string): string | number | undefined;
+    abstract _handleText(text: string): string | number | undefined;
+}
+declare class StringCell extends BaseStringCell {
+    readonly _type = "string";
+    constructor(props: PrefsRowString, values: PreferenceValues);
+    _handleText(text: string): string;
+}
+declare class NumberCell extends BaseStringCell {
+    readonly _type = "number";
+    _min?: number;
+    _max?: number;
+    constructor(props: PrefsRowNumber, values: PreferenceValues);
+    _handleText(text: string): number | undefined;
+}
+declare class IntegerCell extends BaseStringCell {
+    readonly _type = "integer";
+    _min: number;
+    _max?: number;
+    constructor(props: PrefsRowInteger, values: PreferenceValues);
+    _handleText(text: string): number | undefined;
+}
+declare class StepperCell extends Cell {
+    readonly _type = "stepper";
+    _max?: number;
+    _min: number;
+    constructor(props: PrefsRowStepper, values: PreferenceValues);
+    _defineValueView(): UiTypes.ViewOptions;
+    _handleValue(num: number): number;
+}
+declare class BooleanCell extends Cell {
+    readonly _type = "boolean";
+    _onColor: UIColor;
+    _thumbColor?: UIColor;
+    constructor(props: PrefsRowBoolean, values: PreferenceValues);
+    _defineValueView(): UiTypes.SwitchOptions;
+    _handleValue(bool: boolean): boolean;
+}
+declare class SliderCell extends Cell {
+    readonly _type = "slider";
+    _decimal: number;
+    _min: number;
+    _max: number;
+    _minColor: UIColor;
+    _maxColor?: UIColor;
+    _thumbColor?: UIColor;
+    constructor(props: PrefsRowSlider, values: PreferenceValues);
+    _defineValueView(): UiTypes.ViewOptions;
+    _handleValue(num: number): number;
+}
+declare class ListCell extends Cell {
+    readonly _type = "list";
+    _items: string[];
+    constructor(props: PrefsRowList, values: PreferenceValues);
+    _defineValueView(): UiTypes.ViewOptions;
+    _handleValue(num: number): number;
+}
+declare class TabCell extends Cell {
+    readonly _type = "tab";
+    _items: string[];
+    constructor(props: PrefsRowTab, values: PreferenceValues);
+    _defineValueView(): UiTypes.TabOptions;
+    _handleValue(num: number): number;
+}
+export declare function dateToString(mode: number, date?: Date): string;
+declare class DateCell extends Cell {
+    readonly _type = "date";
+    _mode: number;
+    _interval?: number;
+    _min?: Date;
+    _max?: Date;
+    constructor(props: PrefsRowDate, values: PreferenceValues);
+    _defineValueView(): UiTypes.ViewOptions;
+    _handleValue(date: Date): Date;
+}
+declare class InfoCell extends Cell {
+    readonly _type = "info";
+    constructor(props: PrefsRowInfo, values: PreferenceValues);
+    _defineValueView(): UiTypes.LabelOptions;
+    _handleValue(text: string): string;
+}
+declare class InteractiveInfoCell extends Cell {
+    readonly _type = "interactive-info";
+    _copyable: boolean;
+    constructor(props: PrefsRowInteractiveInfo, values: PreferenceValues);
+    _defineValueView(): UiTypes.LabelOptions;
+    _handleValue(text: string): string;
+}
+declare class LinkCell extends Cell {
+    readonly _type = "link";
+    constructor(props: PrefsRowLink, values: PreferenceValues);
+    _defineValueView(): UiTypes.LabelOptions;
+    _handleValue(text: string): string;
+}
+declare class SymbolActionCell extends Cell {
+    readonly _type = "symbol-action";
+    _symbol: string;
+    _tintColor: UIColor;
+    _contentMode: number;
+    _symbolSize: JBSize;
+    constructor(props: PrefsRowSymbolAction, values: PreferenceValues);
+    _defineValueView(): UiTypes.ImageOptions;
+    _handleValue(): void;
+}
+declare class ActionCell extends Cell {
+    readonly _type = "action";
+    _destructive: boolean;
+    constructor(props: PrefsRowAction, values: PreferenceValues);
+    _defineTitleView(): UiTypes.LabelOptions;
+    _defineValueView(): UiTypes.LabelOptions;
+    _handleValue(): void;
+}
+/**
+ * # cview PreferenceListView_static
+ *
+ * 便捷的设置列表实现. 其所有 cell 均为静态 cell,
+ * 可以同时使用 list 控件的 props(除了 template, data)和 events(除了 didSelect),
+ * 同时具有独特方法 set(key, value), 以及独特方法 changed
+ *
+ * sections 为 Array, 里面的 section 定义:
+ *
+ * - title?: string 标题.
+ * - rows: {type: string}[] 内容
+ *
+ * row定义:
+ *
+ * - 通用:
+ *
+ *     - type: string 类型. 包括'string', 'number', 'integer', 'stepper',
+ *       'boolean', 'slider', 'list', 'tab', 'interactive-info', 'info',
+ *       'link', 'action'
+ *     - key?: string 键. 如没有则不会返回其值.
+ *     - title?: string 标题
+ *     - value?: any 在下面专项里详解.
+ *     - titleColor?: $color = $color("primaryText") 标题颜色
+ *
+ * -  string:
+ *
+ *     - value?: string
+ *     - placeholder?: string
+ *     - textColor?: $color = $color("primaryText")
+ *
+ * -  number, integer:
+ *
+ *     - value?: number
+ *     - placeholder?: string
+ *     - textColor?: $color = $color("primaryText")
+ *     - min?: number 最小值
+ *     - max?: number 最大值
+ *
+ * - stepper:
+ *
+ *     - value?: number
+ *     - placeholder?: string
+ *     - min?: number 最小值
+ *     - max?: number 最大值
+ *
+ * - boolean:
+ *
+ *     - value?: boolean
+ *     - onColor?: $color = $color("#34C85A")
+ *     - thumbColor
+ *
+ * - slider:
+ *
+ *     - value?: number 即 slider.value
+ *     - decimal?: number = 1 精度
+ *     - min?: number
+ *     - max?: number
+ *     - minColor?: $color = $color("systemLink")
+ *     - maxColor?: $color
+ *     - thumbColor?: $color
+ *
+ * - list:
+ *
+ *     - value?: number 即 index, -1 时为不选
+ *     - items?: string[]
+ *
+ * - tab:
+ *
+ *     - value?: number 即 index, -1 时为不选
+ *     - items?: string[]
+ *
+ * - date:
+ *
+ *    - value?: Date
+ *    - min?: Date
+ *    - max?: Date
+ *    - mode?: number = 2
+ *    - interval?: number
+ *
+ * - info:
+ *
+ *     - value?: string
+ *
+ * - interactive-info:
+ *
+ *    - value?: string
+ *    - copyable?: boolean = false
+ *
+ * - link:
+ *
+ *     - value?: string url
+ *
+ * - symbol-action:
+ *
+ *    - symbol?: string;
+ *    - tintColor?: UIColor;
+ *    - contentMode?: number;
+ *    - symbolSize?: JBSize;
+ *    - value?: function 点击后会执行的函数
+ *
+ * - action:
+ *
+ *     - value?: function 点击后会执行的函数
+ *     - destructive?: boolean = false 是否为危险动作，若是则为红色
+ *
+ * Methods:
+ *
+ * - set(key, value) 设定 key 对应的 value
+ * - cview.values 获取全部的 values
+ *
+ * Events:
+ *
+ * - changed: values => {}
+ */
+export declare class PreferenceListView extends Base<UIListView, UiTypes.ListOptions> {
+    _defineView: () => UiTypes.ListOptions;
+    _sections: PreferenceSection[];
+    _props: Partial<UiTypes.ListProps>;
+    _layout?: (make: MASConstraintMaker, view: UIListView) => void;
+    _values: PreferenceValues;
+    _cells: {
+        title: string;
+        rows: AllCells[];
+    }[];
+    constructor({ sections, props, layout, events, }: {
+        sections: PreferenceSection[];
+        props?: Partial<UiTypes.ListProps>;
+        layout?: (make: MASConstraintMaker, view: UIListView) => void;
+        events?: {
+            changed?: (values: {
+                [key: string]: any;
+            }) => void;
+        };
+    });
+    private _createCell;
+    get values(): PreferenceValues;
+    set(key: string, value: any): void;
+}
+export {};

package/dist/components/symbol-button.d.ts

@@ -0,0 +1,39 @@
+import { Base } from "./base";
+interface SymbolButtonProps {
+    enabled: boolean;
+    symbol?: string;
+    image?: UIImage;
+    src?: string;
+    tintColor: UIColor;
+    contentMode: number;
+    insets: JBInsets;
+    menu?: UiTypes.ContextMenuOptions<UIButtonView>;
+    hidden: boolean;
+}
+/**
+ * 创建可以自动规范symbol大小的button，兼容image，可以设定insets
+ * props:
+ *   - symbol
+ *   - image
+ *   - tintColor
+ *   - insets
+ *   - enabled
+ *   - menu
+ *   - hidden
+ * events:
+ *   - tapped
+ */
+export declare class SymbolButton extends Base<UIButtonView, UiTypes.ButtonOptions> {
+    _props: SymbolButtonProps;
+    _defineView: () => UiTypes.ButtonOptions;
+    constructor({ props, layout, events, }: {
+        props: Partial<SymbolButtonProps>;
+        layout?: (make: MASConstraintMaker, view: UIButtonView) => void;
+        events?: UiTypes.BaseViewEvents<UIButtonView>;
+    });
+    set tintColor(tintColor: UIColor);
+    set image(image: UIImage);
+    set symbol(symbol: string);
+    set src(src: string);
+}
+export {};

package/dist/components/tabbar.d.ts

@@ -0,0 +1,140 @@
+import { Base } from "./base";
+declare class ImageLabelCell extends Base<UIView, UiTypes.ViewOptions> {
+    _props: {
+        symbol?: string;
+        image?: UIImage;
+        text: string;
+        index: number;
+        selectedSegmentTintColor: UIColor;
+        defaultSegmentTintColor: UIColor;
+        selected?: boolean;
+    };
+    layouts: {
+        image_tightened: (make: MASConstraintMaker, view: AllUIView) => void;
+        label_tightened: (make: MASConstraintMaker, view: AllUIView) => void;
+        image_loosed: (make: MASConstraintMaker, view: AllUIView) => void;
+        label_loosed: (make: MASConstraintMaker, view: AllUIView) => void;
+    };
+    _defineView: () => UiTypes.ViewOptions;
+    constructor({ props, events, }: {
+        props: {
+            symbol?: string;
+            image?: UIImage;
+            text: string;
+            index: number;
+            selectedSegmentTintColor: UIColor;
+            defaultSegmentTintColor: UIColor;
+            selected?: boolean;
+        };
+        events: {
+            tapped?: (index: number) => void;
+        };
+    });
+    set selected(selected: boolean | undefined);
+    get selected(): boolean | undefined;
+    _useTightenedLayout(): void;
+    _useLoosedLayout(): void;
+}
+declare class ImageCell extends Base<UIView, UiTypes.ViewOptions> {
+    _props: {
+        symbol?: string;
+        image?: UIImage;
+        index: number;
+        selectedSegmentTintColor: UIColor;
+        defaultSegmentTintColor: UIColor;
+        selected?: boolean;
+    };
+    layouts: {
+        image_tightened: (make: MASConstraintMaker, view: AllUIView) => void;
+        image_loosed: (make: MASConstraintMaker, view: AllUIView) => void;
+    };
+    _defineView: () => UiTypes.ViewOptions;
+    constructor({ props, events, }: {
+        props: {
+            symbol?: string;
+            image?: UIImage;
+            index: number;
+            selectedSegmentTintColor: UIColor;
+            defaultSegmentTintColor: UIColor;
+            selected?: boolean;
+        };
+        events: {
+            tapped?: (index: number) => void;
+        };
+    });
+    set selected(selected: boolean | undefined);
+    get selected(): boolean | undefined;
+    _useTightenedLayout(): void;
+    _useLoosedLayout(): void;
+}
+/**
+ * 本组件是为了仿制 UITabBar
+ * 本组件不能指定布局而是应该指定 height（如果需要的话）
+ * 典型的使用方式是添加在布局为$layout.fill的视图中，并指定 items
+ *
+ * props:
+ *
+ * - 只写 height: number = 50
+ * - 只写 items: {symbol?: string, image?:UIImage, title?: string}[]
+ * - 只写 bgcolor?: UIColor 如果不指定则背景使用blur（style 10），若指定则使用纯色视图
+ * - 读写 index: number = 0
+ * - 只写 selectedSegmentTintColor = $color("tintColor")
+ * - 只写 defaultSegmentTintColor = colors.footBarDefaultSegmentColor
+ *
+ * events:
+ *
+ * - changed: (cview, index) => void
+ * - doubleTapped: (cview, index) => void
+ *
+ * methods:
+ *
+ * - hide(animated=true) 隐藏
+ * - show(animated=true) 显示
+ */
+export declare class TabBar extends Base<UIView | UIBlurView, UiTypes.ViewOptions | UiTypes.BlurOptions> {
+    _props: {
+        height: number;
+        items: {
+            symbol?: string;
+            image?: UIImage;
+            title?: string;
+        }[];
+        index: number;
+        selectedSegmentTintColor: UIColor;
+        defaultSegmentTintColor: UIColor;
+        bgcolor?: UIColor;
+    };
+    _index: number;
+    _cells: (ImageLabelCell | ImageCell)[];
+    _events: {
+        changed?: (cview: TabBar, index: number) => void;
+        doubleTapped?: (cview: TabBar, index: number) => void;
+    };
+    _defineView: () => UiTypes.ViewOptions | UiTypes.BlurOptions;
+    constructor({ props, events, }: {
+        props: {
+            height?: number;
+            items: {
+                symbol?: string;
+                image?: UIImage;
+                title?: string;
+            }[];
+            index?: number;
+            selectedSegmentTintColor?: UIColor;
+            defaultSegmentTintColor?: UIColor;
+            bgcolor?: UIColor;
+        };
+        events: {
+            changed?: (cview: TabBar, index: number) => void;
+            doubleTapped?: (cview: TabBar, index: number) => void;
+        };
+    });
+    _defineCells(): (ImageLabelCell | ImageCell)[];
+    get index(): number;
+    set index(index: number);
+    hide(animated?: boolean): void;
+    show(animated?: boolean): void;
+    _useTightenedLayout(): void;
+    _useLoosedLayout(): void;
+}
+export {};

package/dist/controller/base-controller.d.ts

@@ -0,0 +1,108 @@
+import { Base } from "../components/base";
+import { ContentView } from "../components/single-views";
+export declare class ControllerRootView extends ContentView {
+    constructor({ props, layout, events, }: {
+        props: {
+            bgcolor: UIColor;
+        };
+        layout: (make: MASConstraintMaker, view: UIView) => void;
+        events: {
+            ready: (sender: UIView) => void;
+        };
+    });
+    set views(views: UiTypes.AllViewOptions[] | Base<any, any>[]);
+}
+export interface BaseControllerProps {
+    id?: string;
+    bgcolor?: UIColor;
+}
+export interface BaseControllerEvents {
+    didLoad?: (controller: BaseController) => void;
+    didAppear?: (controller: BaseController) => void;
+    didDisappear?: (controller: BaseController) => void;
+    didRemove?: (controller: BaseController) => void;
+}
+/**
+ * # CView Base Controller
+ *
+ * Cview 控件尽量保持非侵入性和功能专注。而控制器负责控件之间的关联和数据更新。
+ * 另外，控制器可以实现一些常用的页面构建形式，比如底部Tab分页，左侧滑动分页，弹出式页面等。
+ *
+ * ## 属性
+ *
+ * - id?: string 可以指定 id，如不指定，会自动赋值全局唯一 id
+ * - 只写 bgcolor?: UIColor = $color("primarySurface") rootView 的 bgcolor
+ * - 只读 cviews: {}
+ * - 只读 rootView
+ * - 只读 status
+ *   - created = 0 被创建，未被加载
+ *   - loaded = 1 被加载，显示状态未知
+ *   - appearing = 2 处于可显示状态
+ *   - disappearing = 3 处于不显示状态
+ *   - removed = 4 根视图被移除
+ *
+ * ## 事件
+ *
+ * 5 个生命周期节点：创建、加载、显示、隐藏、销毁。后面四个具有生命周期事件。
+ *
+ * 创建阶段没有对应事件，此阶段适合为 rootView 添加子 view，
+ * 不能涉及对 UIView 的任何操作，因为此时 rootView 还未加载。
+ *
+ * 生命周期事件：
+ *
+ * 1. didLoad: controller => void 在 rootView 被加载之后执行
+ *    - 可以在 rootView 的 ready 事件中自动执行，也可以手动执行加快速度
+ *    - 也可以在这个节点为 rootView 添加子 view
+ *    - 这个节点可以对 UIView 进行操作了
+ *    - 可以向 Model 层请求初始数据
+ * 2. didAppear: controller => void 在 rootView 显现的时候执行
+ *    - 向 Model 层请求刷新数据
+ * 3. didDisappear: controller => void 在 rootView 不可见的时候执行
+ *    - 如果是持续执行的刷新行为，可以在此处转为暂停
+ * 4. didRemove: controller => void 在 rootView 被移除的时候执行
+ *    - 应该在此节点释放自定义的 objc
+ *    - 数据持久化
+ *
+ * ## 方法
+ *
+ * 加载方法：
+ *
+ * 1. uirender(props) 此方法只能使用一次，对应的 Controller 将成为顶级 Controller
+ * 2. uipush(props)
+ * 3. 直接让 rootView.definition 包含在其他 View 的 views 参数中
+ *
+ * 生命周期管理：
+ *
+ * 1. load() 会在 rootView 的 ready 事件中自动调用，也可以手动调用，以加速运行
+ * 2. appear()
+ * 3. disappear()
+ * 4. remove() 用来移除 Router 中的当前 Controller，**请注意此方法和 rootView 的移除无关**，
+ *    如果通过 uirender 和 uipush，可以在销毁时自动执行 remove()
+ *
+ * ## 其他
+ *
+ * - rootView 可以直接通过 rootView.views 设置其_views 属性，
+ *   其中元素可以为 view 定义也可以为 cview
+ */
+export declare class BaseController {
+    protected _props: BaseControllerProps;
+    protected _events: BaseControllerEvents;
+    readonly id: string;
+    private _status;
+    cviews: {
+        [key: string]: Base<any, any>;
+    };
+    readonly rootView: ControllerRootView;
+    constructor({ props, layout, events, }?: {
+        props?: BaseControllerProps;
+        layout?: (make: MASConstraintMaker, view: UIView) => void;
+        events?: BaseControllerEvents;
+    });
+    load(): void;
+    appear(): void;
+    disappear(): void;
+    remove(): void;
+    uirender(props: UiTypes.RootViewPrefs): void;
+    uipush(props: UiTypes.RootViewPrefs): void;
+    get status(): number;
+}