@wcardinal/wcardinal-ui 0.227.0 → 0.228.0

package/README.md

@@ -56,11 +56,11 @@ new DButtonCheck({
 </script>
 ```
 
-All the classes are in the `wcardinal.ui`.
-Please note that the `loadAll` and the `loadThemeWhiteALl` is not required in this case.
-Prebuild files `wcardinal-ui.min.js` and `wcardinal-ui-theme-white.min.js` call the `loadAll` and the `loadThemeWhiteAll` for you.
+All the classes are in `wcardinal.ui`.
+Please note that `loadAll` and `loadThemeWhiteALl` is not required in this case.
+Prebuild files `wcardinal-ui.min.js` and `wcardinal-ui-theme-white.min.js` call `loadAll` and `loadThemeWhiteAll` for you.
 
-See [sample/cdn](https://winter-cardinal.github.io/winter-cardinal-ui/sample/white/other/cdn.html) for complete example.
+See [sample/cdn](https://winter-cardinal.github.io/winter-cardinal-ui/sample/white/other/cdn.html) for a complete example.
 
 ### Tree shaking
 
@@ -68,15 +68,15 @@ The NPM package `@wcardinal/wcardinal-ui` is large in its size
 because all the UI classes and their themes are included.
 This is why the tree shaking is important for this library.
 
-The `loadAll` loads all the optional modules (e.g., `DMenuItemCheck`).
-And the `loadThemeWhiteAll` loads the white theme (e.g., `DThemeWhite`).
+`loadAll` loads all the optional modules (e.g., `DMenuItemCheck`).
+And `loadThemeWhiteAll` loads the white theme (e.g., `DThemeWhite`).
 To remove unnecessary modules from your build, pick `load*` functions you need.
 
 ```javascript
 import { loadThemeWhiteAll } from '@wcardinal/wcardinal-ui';
 
 // Loads the white theme only.
-// `DMenuItemCheck` will not be in your compiled package.
+// `DMenuItemCheck` will not be in your compiled package, for instance.
 loadThemeWhiteAll();
 ```
 
@@ -126,7 +126,7 @@ npm start
 
 #### API document
 
-Update the `gitRevision` in the `typedoc.json` and then do
+Update `gitRevision` in `typedoc.json` and then do
 
 ```shell
 npm run build:api
@@ -174,7 +174,6 @@ npm run lint:fix
 
 Apache License Version 2.0.
 
-The default theme uses Material Design icons by Google
-licensed under Apache license version 2.0.\
+The default theme uses Material design icons developed by Google and licensed under Apache license version 2.0.\
 https://github.com/google/material-design-icons
 

package/dist/types/wcardinal/ui/d-base.d.ts

@@ -51,8 +51,6 @@ export interface DBaseEvents<EMITTER> {
     /**
      * Triggered when an initialization is finished.
      *
-     *     on( "init", ( emitter ) => {} )
-     *
      * @param emitter an emitter
      */
     init(emitter: EMITTER): void;

package/dist/types/wcardinal/ui/d-list-data-selection.d.ts

@@ -1,5 +1,8 @@
 import { utils } from "pixi.js";
 import { DOnOptions } from "./d-on-options";
+/**
+ * {@link DListDataSelection} type.
+ */
 export declare const DListDataSelectionType: {
     readonly NONE: 0;
     readonly SINGLE: 1;
@@ -7,7 +10,7 @@ export declare const DListDataSelectionType: {
 };
 export declare type DListDataSelectionType = typeof DListDataSelectionType[keyof typeof DListDataSelectionType];
 /**
- * {@link DListSelection} events.
+ * {@link DListDataSelection} events.
  */
 export interface DListDataSelectionEvents<EMITTER> {
     /**
@@ -18,12 +21,12 @@ export interface DListDataSelectionEvents<EMITTER> {
     change(emitter: EMITTER): void;
 }
 /**
- * {@link DListSelection} "on" options.
+ * {@link DListDataSelection} "on" options.
  */
 export interface DListDataSelectionOnOptions<EMITTER> extends Partial<DListDataSelectionEvents<EMITTER>>, DOnOptions {
 }
 /**
- * {@link DListSelection} options.
+ * {@link DListDataSelection} options.
  */
 export interface DListDataSelectionOptions<ITEM, EMITTER = any> {
     /**

package/dist/types/wcardinal/ui/d-list-item.d.ts

@@ -11,16 +11,14 @@ export interface DListItemEvents<VALUE, EMITTER> extends DImageBaseEvents<VALUE,
     /**
      * Triggered when a value is set.
      *
-     *     on( "set", ( node, index, emitter ) => {} )
-     *
+     * @param value a value set
+     * @param index an index number of a value
      * @param emitter an emitter
      */
-    set(node: VALUE, index: number, emitter: EMITTER): void;
+    set(value: VALUE, index: number, emitter: EMITTER): void;
     /**
      * Triggered when set to undefined.
      *
-     *     on( "unset", ( emitter ) => {} )
-     *
      * @param emitter an emitter
      */
     unset(emitter: EMITTER): void;
@@ -28,8 +26,6 @@ export interface DListItemEvents<VALUE, EMITTER> extends DImageBaseEvents<VALUE,
      * Triggered when selected.
      * Please note that even when selected, {@link DList} selection state may not be changed.
      *
-     *     on( "select", ( value, emitter ) => {} )
-     *
      * @param value a value
      * @param emitter an emitter
      */

package/dist/types/wcardinal/ui/d-table-body-cell.d.ts

@@ -28,7 +28,7 @@ export interface DTableBodyCell<ROW, VALUE> extends DBase {
     set(value: unknown, row: ROW, supplimental: unknown, rowIndex: number, columnIndex: number, forcibly?: boolean): void;
     unset(): void;
     /**
-     * Called when the selection type is not {@link DTableDataSelectionType.NONE}
+     * Called when the selection type is not {@link DTableDataSelectionType}'s NONE
      * and a cell is clicked. Returning true will prevent the row selection.
      * Otherwise, a clicked row will be selected.
      *

package/dist/types/wcardinal/ui/d-table-data-selection.d.ts

@@ -1,6 +1,9 @@
 import { utils } from "pixi.js";
 import { DOnOptions } from "./d-on-options";
 import { DTableData } from "./d-table-data";
+/**
+ * {@link DTableDataSelection} type.
+ */
 export declare const DTableDataSelectionType: {
     readonly NONE: 0;
     readonly SINGLE: 1;
@@ -14,8 +17,6 @@ export interface DTableDataSelectionEvents<EMITTER> {
     /**
      * Triggered when s selection is changed.
      *
-     *     on( "change", ( emitter ) => {} )
-     *
      * @param emitter an emitter
      */
     change(emitter: EMITTER): void;

package/dist/types/wcardinal/ui/d-tree-data-selection.d.ts

@@ -1,6 +1,9 @@
 import { utils } from "pixi.js";
 import { DOnOptions } from "./d-on-options";
 import { DTreeNode } from "./d-tree-node";
+/**
+ * {@link DTreeDataSelection} type.
+ */
 export declare const DTreeDataSelectionType: {
     readonly NONE: 0;
     readonly SINGLE: 1;
@@ -8,7 +11,7 @@ export declare const DTreeDataSelectionType: {
 };
 export declare type DTreeDataSelectionType = typeof DTreeDataSelectionType[keyof typeof DTreeDataSelectionType];
 /**
- * {@link DListSelection} events.
+ * {@link DTreeDataSelection} events.
  */
 export interface DTreeDataSelectionEvents<EMITTER> {
     /**
@@ -19,12 +22,12 @@ export interface DTreeDataSelectionEvents<EMITTER> {
     change(emitter: EMITTER): void;
 }
 /**
- * {@link DListSelection} "on" options.
+ * {@link DTreeDataSelection} "on" options.
  */
 export interface DTreeDataSelectionOnOptions<EMITTER> extends Partial<DTreeDataSelectionEvents<EMITTER>>, DOnOptions {
 }
 /**
- * {@link DListSelection} options.
+ * {@link DTreeDataSelection} options.
  */
 export interface DTreeDataSelectionOptions<ITEM, EMITTER = any> {
     /**

package/dist/types/wcardinal/ui/d-tree-item-text.d.ts

@@ -12,16 +12,14 @@ export interface DTreeItemTextEvents<NODE, EMITTER> extends DImageBaseEvents<NOD
     /**
      * Triggered when a node is set.
      *
-     *     on( "set", ( node, index, emitter ) => {} )
-     *
+     * @param node a node
+     * @param index an index number of a node
      * @param emitter an emitter
      */
     set(node: NODE, index: number, emitter: EMITTER): void;
     /**
      * Triggered when set to undefined.
      *
-     *     on( "unset", ( emitter ) => {} )
-     *
      * @param emitter an emitter
      */
     unset(emitter: EMITTER): void;

package/dist/types/wcardinal/ui/shape/action/e-shape-action-expression-with-parameter.d.ts

@@ -4,7 +4,7 @@ import { EShapeActionEnvironment } from "./e-shape-action-environment";
  * {@link EShape} action expression with one parameter.
  *
  * In action expressions, all the properties in {@link EShape}, {@link EShapeState} and {@link EShapeActionEnvironment} can be accessed directly.
- * For instance, the string `isClicked` is a valid expression as {@link EShapeState} has {@link EShapeState#isClicked} and is equivalent to `shape.state.isClicked`.
+ * For instance, the string `isClicked` is a valid expression as {@link EShapeState} has {@link EShapeStateSet#isClicked} and is equivalent to `shape.state.isClicked`.
  * In addition to that, the parameter passed to this function can be used in action expressions.
  * The name of the variable containing that parameter depends on actions.
  */

package/dist/types/wcardinal/ui/shape/action/e-shape-action-expression.d.ts

@@ -4,6 +4,6 @@ import { EShapeActionEnvironment } from "./e-shape-action-environment";
  * {@link EShape} action expression.
  *
  * In action expressions, all the properties in {@link EShape}, {@link EShapeState} and {@link EShapeActionEnvironment} can be accessed directly.
- * For instance, the string `isClicked` is a valid expression as {@link EShapeState} has {@link EShapeState#isClicked} and is equivalent to `shape.state.isClicked`.
+ * For instance, the string `isClicked` is a valid expression as {@link EShapeState} has {@link EShapeStateSet#isClicked} and is equivalent to `shape.state.isClicked`.
  */
 export declare type EShapeActionExpression<T> = (shape: EShape, time: number, environment: EShapeActionEnvironment) => T;

package/dist/types/wcardinal/ui/shape/action/e-shape-action-value-misc-type.d.ts

@@ -8,11 +8,11 @@ export declare const EShapeActionValueMiscType: {
     readonly WRITE_REMOTE: 6;
     readonly HTML_ELEMENT: 7;
     readonly HTML_ELEMENT_WITHOUT_POINTER_EVENTS: 8;
-    /** @deprecated in favor of {@link EShapeActionValueShowHideType.LAYER} */
+    /** @deprecated in favor of {@link EShapeActionValueShowHideType}'s LAYER */
     readonly SHOW_HIDE_LAYER: 9;
-    /** @deprecated in favor of {@link EShapeActionValueType.GESTURE} */
+    /** @deprecated in favor of {@link EShapeActionValueType}'s GESTURE */
     readonly GESTURE_LAYER: 10;
-    /** @deprecated in favor of {@link EShapeActionValueType.GESTURE} */
+    /** @deprecated in favor of {@link EShapeActionValueType}'s GESTURE */
     readonly GESTURE: 11;
     readonly EXECUTE: 12;
 };

package/dist/types/wcardinal/ui/shape/action/e-shape-action-value-open-type.d.ts

@@ -3,7 +3,7 @@ export declare const EShapeActionValueOpenType: {
     readonly DIAGRAM_LEGACY: 0;
     /** @deprecated in favor of {@link PAGE} */
     readonly PAGE_LEGACY: 1;
-    /** @deprecated in favor of {@link PAGE */
+    /** @deprecated in favor of {@link PAGE} */
     readonly PAGE_INPLACE_LEGACY: 2;
     /** @deprecated in favor of {@link DIALOG} */
     readonly DIALOG_TEXT: 3;

package/dist/types/wcardinal/ui/shape/action/e-shape-action-value-type.d.ts

@@ -3,9 +3,9 @@ export declare const EShapeActionValueType: {
     readonly BLINK: 1;
     readonly TRANSFORM: 2;
     readonly OPEN: 3;
-    /** @deprecated in favor of {@link EShapeActionValueMiscType.MISC} */
+    /** @deprecated in favor of {@link EShapeActionValueMiscType}'s MISC */
     readonly EMIT_EVENT: 4;
-    /** @deprecated in favor of {@link EShapeActionValueType.CHANGE_COLOR} */
+    /** @deprecated in favor of {@link EShapeActionValueType}'s CHANGE_COLOR */
     readonly CHANGE_COLOR_LEGACY: 5;
     readonly CHANGE_TEXT: 6;
     readonly CHANGE_CURSOR: 7;

package/dist/types/wcardinal/ui/shape/e-shape-copy-part.d.ts

@@ -8,7 +8,7 @@ export declare const EShapeCopyPart: {
     readonly STATE: 32;
     readonly IMAGE: 64;
     readonly DATA: 128;
-    /** @deprecated in favor of {@link data} */
+    /** @deprecated in favor of {@link DATA} */
     readonly TAG: 128;
     readonly CONNECTOR: 256;
     readonly ALL: number;

package/dist/types/wcardinal/ui/shape/index.d.ts

@@ -33,6 +33,8 @@ export * from "./e-shape-data-mapping-impl";
 export * from "./e-shape-data-mapping";
 export * from "./e-shape-data-scoped-impl";
 export * from "./e-shape-data-scoped";
+export * from "./e-shape-data-system-impl";
+export * from "./e-shape-data-system";
 export * from "./e-shape-data-value-extension";
 export * from "./e-shape-data-value-extensions";
 export * from "./e-shape-data-value-formatter";