jsbox-cview 1.3.5 → 1.4.0

package/components/static-preference-listview.ts

@@ -1,98 +1,3 @@
-/**
- * # 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[]
- * 
- * - info:
- * 
- *     - value?: string
- * 
- * - interactive-info:
- * 
- *    - value?: string
- *    - copyable?: boolean = false
- * 
- * - link:
- * 
- *     - value?: string url
- * 
- * - action:
- * 
- *     - value?: function 点击后会执行的函数
- *     - destructive?: boolean = false 是否为危险动作，若是则为红色
- * 
- * Methods:
- * 
- * - set(key, value) 设定 key 对应的 value
- * - cview.values 获取全部的 values
- * 
- * Events:
- * 
- * - changed: values => {}
- */
-
 import { Base } from "./base";
 import { getTextWidth } from "../utils/uitools";
 
@@ -881,6 +786,100 @@ class ActionCell extends Cell {
   }
 }
 
+/**
+ * # 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[]
+ * 
+ * - info:
+ * 
+ *     - value?: string
+ * 
+ * - interactive-info:
+ * 
+ *    - value?: string
+ *    - copyable?: boolean = false
+ * 
+ * - link:
+ * 
+ *     - value?: string url
+ * 
+ * - action:
+ * 
+ *     - value?: function 点击后会执行的函数
+ *     - destructive?: boolean = false 是否为危险动作，若是则为红色
+ * 
+ * Methods:
+ * 
+ * - set(key, value) 设定 key 对应的 value
+ * - cview.values 获取全部的 values
+ * 
+ * Events:
+ * 
+ * - changed: values => {}
+ */
 export class PreferenceListView extends Base<UIListView, UiTypes.ListOptions> {
   _defineView: () => UiTypes.ListOptions;
   _sections: PreferenceSection[];

package/components/symbol-button.ts

@@ -1,18 +1,3 @@
-/**
- * #cview symbolButton
- *
- * 创建可以自动规范symbol大小的button，兼容image，可以设定insets
- *
- * props:
- *   - symbol
- *   - image
- *   - tintColor
- *   - insets
- *
- * events:
- *  - tapped
- */
-
 import { Base } from "./base";
 
 interface SymbolButtonProps extends UiTypes.ButtonProps {
@@ -22,6 +7,7 @@ interface SymbolButtonProps extends UiTypes.ButtonProps {
 interface SymbolButtonPropsOptional extends UiTypes.ButtonProps {
   insets?: JBInsets
 }
+
 /**
  * 创建可以自动规范symbol大小的button，兼容image，可以设定insets
  * props:
@@ -35,10 +21,10 @@ interface SymbolButtonPropsOptional extends UiTypes.ButtonProps {
 export class SymbolButton extends Base<UIButtonView, UiTypes.ButtonOptions> {
   _props: SymbolButtonProps
   _defineView: () => UiTypes.ButtonOptions;
-  constructor({ 
-    props, 
-    layout, 
-    events = {} 
+  constructor({
+    props,
+    layout,
+    events = {}
   }: {
     props: SymbolButtonPropsOptional;
     layout?: (make: MASConstraintMaker, view: UIButtonView) => void;
@@ -52,17 +38,17 @@ export class SymbolButton extends Base<UIButtonView, UiTypes.ButtonOptions> {
     };
     this._layout = layout;
     this._defineView = () => {
-      const props = this._props.menu 
-      ? {
-        radius: 0,
-        bgcolor: $color("clear"),
-        id: this.id,
-        menu: this._props.menu,
-      } : {
-        radius: 0,
-        bgcolor: $color("clear"),
-        id: this.id
-      } 
+      const props = this._props.menu
+        ? {
+          radius: 0,
+          bgcolor: $color("clear"),
+          id: this.id,
+          menu: this._props.menu,
+        } : {
+          radius: 0,
+          bgcolor: $color("clear"),
+          id: this.id
+        }
       return {
         type: "button",
         props,

package/components/tabbar.ts

@@ -1,28 +1,3 @@
-/**
- * 本组件是为了仿制 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) 显示
- */
-
 import { footBarDefaultSegmentColor } from "../utils/colors";
 import { Base } from "./base";
 
@@ -230,6 +205,30 @@ class ImageCell extends Base<UIView, UiTypes.ViewOptions> {
   }
 }
 
+/**
+ * 本组件是为了仿制 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 class TabBar extends Base<UIView | UIBlurView, UiTypes.ViewOptions | UiTypes.BlurOptions> {
   _props: {
     height: number;

package/controller/base-controller.ts

@@ -1,3 +1,60 @@
+import { Base } from '../components/base';
+import { ContentView } from '../components/single-views';
+import { cvid } from "../utils/cvid";
+import { router } from "./controller-router";
+
+/**
+ * status
+ *   - created = 0 被创建，未被加载
+ *   - loaded = 1 被加载，显示状态未知
+ *   - appeared= 2 处于可显示状态
+ *   - disappeared = 3 处于不显示状态
+ *   - removed = 4 根视图被移除
+ * 其中只有 2 和 3 可以相互转化，其他不可以
+ */
+const controllerStatus = {
+  created: 0,
+  loaded: 1,
+  appeared: 2,
+  disappeared: 3,
+  removed: 4
+};
+
+export class ControllerRootView extends ContentView {
+  constructor({
+    props,
+    layout,
+    events
+  }: {
+    props: { bgcolor: UIColor };
+    layout: (make: MASConstraintMaker, view: UIView) => void;
+    events: { ready: (sender: UIView) => void };
+  }) {
+    super({ props, layout, events });
+  }
+
+  set views(views: UiTypes.AllViewOptions[] | Base<any, any>[]) {
+    const _views: UiTypes.AllViewOptions[] = views.map(v => {
+      if (v instanceof Base) return v.definition;
+      return v;
+    })
+    this._views = _views;
+  }
+}
+
+export interface BaseControllerProps {
+  id?: string;
+  bgcolor?: UIColor;
+}
+
+export interface BaseControllerEvents {
+  didCreate?: (controller: BaseController) => void;
+  didLoad?: (controller: BaseController) => void;
+  didAppear?: (controller: BaseController) => void;
+  didDisappear?: (controller: BaseController) => void;
+  didRemove?: (controller: BaseController) => void;
+}
+
 /** 
  * # CView Base Controller
  * 
@@ -57,64 +114,6 @@
  * 
  * - rootView 可以直接通过 rootView.views 设置其_views 属性，其中元素可以为 view 定义也可以为 cview
  */
-
-import { Base } from '../components/base';
-import { ContentView } from '../components/single-views';
-import { cvid } from "../utils/cvid";
-import { router } from "./controller-router";
-
-/**
- * status
- *   - created = 0 被创建，未被加载
- *   - loaded = 1 被加载，显示状态未知
- *   - appeared= 2 处于可显示状态
- *   - disappeared = 3 处于不显示状态
- *   - removed = 4 根视图被移除
- * 其中只有 2 和 3 可以相互转化，其他不可以
- */
-const controllerStatus = {
-  created: 0,
-  loaded: 1,
-  appeared: 2,
-  disappeared: 3,
-  removed: 4
-};
-
-export class ControllerRootView extends ContentView {
-  constructor({
-    props,
-    layout,
-    events
-  }: {
-    props: { bgcolor: UIColor };
-    layout: (make: MASConstraintMaker, view: UIView) => void;
-    events: { ready: (sender: UIView) => void };
-  }) {
-    super({ props, layout, events });
-  }
-
-  set views(views: UiTypes.AllViewOptions[] | Base<any, any>[]) {
-    const _views: UiTypes.AllViewOptions[] = views.map(v => {
-      if (v instanceof Base) return v.definition;
-      return v;
-    })
-    this._views = _views;
-  }
-}
-
-export interface BaseControllerProps {
-  id?: string;
-  bgcolor?: UIColor;
-}
-
-export interface BaseControllerEvents {
-  didCreate?: (controller: BaseController) => void;
-  didLoad?: (controller: BaseController) => void;
-  didAppear?: (controller: BaseController) => void;
-  didDisappear?: (controller: BaseController) => void;
-  didRemove?: (controller: BaseController) => void;
-}
-
 export class BaseController {
   protected _props: BaseControllerProps;
   protected _events: BaseControllerEvents;

package/controller/controller-router.ts

@@ -1,3 +1,5 @@
+import { BaseController } from "./base-controller";
+
 /**
  * 控制器的路由器，用于管理控制器的集合和操作。
  * 
@@ -12,9 +14,6 @@
  * - `get(id: string)`：根据控制器的ID获取控制器。
  * 
  */
-
-import { BaseController } from "./base-controller";
-
 class Router {
   private _set: Set<BaseController>;
   root?: BaseController;

package/controller/pageviewer-controller.ts

@@ -1,14 +1,3 @@
-/** 
- * # CView PageViewer Controller
- * 
- * 一个可以左右滑动翻页的控制器。
- * 
- * Props:
- * 
- * - items: { controller: Controller, title: string }[]
- * - navBarProps: {} 可用于 navBar 的其他属性，不包括 title 和 titleView
- */
-
 import { BaseController, BaseControllerProps, BaseControllerEvents, ControllerRootView } from "./base-controller";
 import { PageViewer } from "../components/pageviewer";
 import { PageViewerTitleBar } from "../components/pageviewer-titlebar";
@@ -20,6 +9,16 @@ interface PageViewerControllerProps extends BaseControllerProps {
   index?: number;
 }
 
+/** 
+ * # CView PageViewer Controller
+ * 
+ * 一个可以左右滑动翻页的控制器。
+ * 
+ * Props:
+ * 
+ * - items: { controller: Controller, title: string }[]
+ * - navBarProps: {} 可用于 navBar 的其他属性，不包括 title 和 titleView
+ */
 export class PageViewerController extends BaseController {
   protected _props: PageViewerControllerProps;
   cviews: {
@@ -32,10 +31,12 @@ export class PageViewerController extends BaseController {
     layout?: (make: MASConstraintMaker, view: UIView) => void;
     events?: BaseControllerEvents;
   }) {
-    super({ props: {
-      id: props.id,
-      bgcolor: props.bgcolor
-    }, layout, events });
+    super({
+      props: {
+        id: props.id,
+        bgcolor: props.bgcolor
+      }, layout, events
+    });
     this._props = props;
     this.cviews = {} as {
       pageviewer: PageViewer;

package/controller/presented-page-controller.ts

@@ -1,3 +1,12 @@
+import { BaseController, BaseControllerProps, BaseControllerEvents, ControllerRootView } from "./base-controller";
+import { Sheet } from "../components/sheet";
+
+interface PresentedPageControllerProps extends BaseControllerProps {
+  presentMode?: number;
+  animated?: boolean;
+  interactiveDismissalDisabled?: boolean;
+}
+
 /** # CView PresentedPageController
  * 
  * ## Props
@@ -15,16 +24,6 @@
  * ## 布局
  * 此控制器的 layout 必定为 `$layout.fill`，无需自行设定
  */
-
-import { BaseController, BaseControllerProps, BaseControllerEvents, ControllerRootView } from "./base-controller";
-import { Sheet } from "../components/sheet";
-
-interface PresentedPageControllerProps extends BaseControllerProps {
-  presentMode?: number;
-  animated?: boolean;
-  interactiveDismissalDisabled?: boolean;
-}
-
 export class PresentedPageController extends BaseController {
   private _sheet: Sheet<ControllerRootView, UIView, UiTypes.ViewOptions>;
   constructor({ props, layout, events }: {
@@ -32,9 +31,11 @@ export class PresentedPageController extends BaseController {
     layout?: (make: MASConstraintMaker, view: UIView) => void;
     events?: BaseControllerEvents;
   } = {}) {
-    super({ props: {
-      id: props?.id
-    }, layout, events });
+    super({
+      props: {
+        id: props?.id
+      }, layout, events
+    });
     this._sheet = new Sheet<ControllerRootView, UIView, UiTypes.ViewOptions>({
       presentMode: props?.presentMode || 1,
       animated: props?.animated || true,

package/controller/splitview-controller.ts

@@ -1,15 +1,3 @@
-/** # CView SplitView Controller
- * 
- * 实现左右分栏布局的控制器, 本身不提供除了分割线以外的视觉效果
- * 
- * 此控制器加载后，会禁用原本的ScreenEdgePanGesture，此控制器应该作为根控制器使用
- * 
- * ## Props
- * 
- * - 只写 items: { controller: Controller, bgcolor: UIColor }[] 其中第一个放在主视图上, 第二个放在次视图上
- * - 读写 sideBarShown: boolean = false 侧栏是否显示
- */
-
 import { BaseController, BaseControllerProps, BaseControllerEvents } from "./base-controller";
 import { Base } from "../components/base";
 import { ContentView } from "../components/single-views";
@@ -173,9 +161,21 @@ interface SplitViewControllerProps extends BaseControllerProps {
   items: { controller: BaseController, bgcolor: UIColor }[];
 }
 
+/** # CView SplitView Controller
+ * 
+ * 实现左右分栏布局的控制器, 本身不提供除了分割线以外的视觉效果
+ * 
+ * 此控制器加载后，会禁用原本的ScreenEdgePanGesture，此控制器应该作为根控制器使用
+ * 
+ * ## Props
+ * 
+ * - 只写 items: { controller: Controller, bgcolor: UIColor }[] 其中第一个放在主视图上, 第二个放在次视图上
+ * - 读写 sideBarShown: boolean = false 侧栏是否显示
+ */
 export class SplitViewController extends BaseController {
   private _screenEdgePanGestureObject: any;
   private _sideBarShown: boolean;
+  private _canShowSidebar: boolean;
   cviews: {
     primaryView: ContentView;
     secondaryView: SecondaryView;
@@ -193,6 +193,7 @@ export class SplitViewController extends BaseController {
       }, layout, events
     });
     this._sideBarShown = false;
+    this._canShowSidebar = true;
     this.cviews = {} as {
       primaryView: ContentView;
       secondaryView: SecondaryView;
@@ -231,7 +232,7 @@ export class SplitViewController extends BaseController {
       ]
     });
     this._screenEdgePanGestureObject = this._defineGestureObject(() => {
-      if (!this.sideBarShown) this.sideBarShown = true;
+      if (!this.sideBarShown && this._canShowSidebar) this.sideBarShown = true;
     });
     this.rootView.views = [this.cviews.secondaryView, this.cviews.primaryView];
   }
@@ -320,4 +321,12 @@ export class SplitViewController extends BaseController {
     }
     this._sideBarShown = bool;
   }
+
+  get canShowSidebar() {
+    return this._canShowSidebar;
+  }
+
+  set canShowSidebar(bool: boolean) {
+    this._canShowSidebar = bool;
+  }
 }

package/controller/tabbar-controller.ts

@@ -1,18 +1,3 @@
-/** 
- * # CView TabBar Controller
- *
- * TabBarController 是一个 PagingController
- *
- * ## 属性
- * 
- * - items: {title?: string, 
- *           symbol?: string, 
- *           image?: UIImage, 
- *           tintColor?: UIColor, 
- *           bgcolor?: UIColor, 
- *           controller: Controller}[]
- * - index: number = 0
- */
 import { BaseController, BaseControllerProps, BaseControllerEvents } from "./base-controller";
 import { ContentView } from "../components/single-views";
 import { TabBar } from "../components/tabbar";
@@ -29,6 +14,21 @@ interface TabBarControllerProps extends BaseControllerProps {
   index?: number;
 }
 
+/** 
+ * # CView TabBar Controller
+ *
+ * TabBarController 是一个 PagingController
+ *
+ * ## 属性
+ * 
+ * - items: {title?: string, 
+ *           symbol?: string, 
+ *           image?: UIImage, 
+ *           tintColor?: UIColor, 
+ *           bgcolor?: UIColor, 
+ *           controller: Controller}[]
+ * - index: number = 0
+ */
 export class TabBarController extends BaseController {
   _props: TabBarControllerProps;
   cviews: {

package/dist/components/alert/input-alert.js

@@ -1,13 +1,20 @@
 "use strict";
-/**
- * # CView InputAlert
- *
- * 显示一个输入框提示
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.inputAlert = void 0;
 const uialert_1 = require("./uialert");
 const l10n_1 = require("../../utils/l10n");
+/**
+ * 显示一个输入框提示
+ *
+ * @param title 标题
+ * @param message 内容
+ * @param text 输入框默认文字
+ * @param placeholder 输入框占位符
+ * @param type 输入框类型
+ * @param secure 是否安全输入
+ * @param cancelText 取消按钮文字
+ * @param confirmText 确认按钮文字
+ */
 function inputAlert({ title = "", message = "", text = "", placeholder, type = 0, secure = false, cancelText = (0, l10n_1.l10n)("CANCEL"), confirmText = (0, l10n_1.l10n)("OK") }) {
     return new Promise((resolve, reject) => {
         const alertVC = new uialert_1.UIAlertController(title, message, uialert_1.UIAlertControllerStyle.Alert);