@dangl/angular-ava 1.1.2-beta0165 → 1.2.0-beta0170

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.
@@ -6,21 +6,87 @@ import { ModeViewType } from './tree-mode.model';
6
6
  import { ITextWords } from '../constants/defaultTextWords';
7
7
  import { IKeyboardOperationConfig } from '../services/keyboard-operation.service';
8
8
  export interface IConfigurationTree {
9
+ /**
10
+ * Optionally, you can supply a map of expansion states for the tree. The keys should be the
11
+ * id properties of the elements in the tree, and the values should be true if the element is
12
+ * expanded, and false if it is collapsed.
13
+ */
9
14
  expansionState?: {
10
15
  [id: string]: boolean;
11
16
  };
17
+ /**
18
+ * Optionally, you can supply the id of the node that should be selected in the tree initially.
19
+ * */
12
20
  selectedNodeId?: string;
21
+ /**
22
+ * Optional, defaults to 20px. If this is set, then the tree will be indented by the given value each level.
23
+ * This can be any valid CSS value for the padding-left property, such as 20px, 1em, or 5%.
24
+ */
13
25
  indent?: string;
26
+ /**
27
+ * Optional, you can supply a color to be used as the background color for the selected line. Defaults to the primary
28
+ * color from the Material theme, which is #00acc1.
29
+ */
14
30
  selectedColor?: string;
31
+ /**
32
+ * You can specify which view type to use for the tree. The default is ModeViewType.Tree, but you can also use
33
+ * ModeViewType.List or ModeViewType.Table.
34
+ */
15
35
  modeView?: ModeViewType;
36
+ /**
37
+ * Optional, defaults to true. If this is disabled, then the double click event for elements is not raised, and clicking on an elemt sends an immediate result since the component has not to wait and check if a double click event is fired.
38
+ */
16
39
  allowDblClick?: boolean;
40
+ /**
41
+ * If this is set to true, then the tree will be in selection mode, and the user can select elements by clicking on them. The selected elements will be emitted in the selectedElementsChanged event.
42
+ */
17
43
  isSelectionMode?: boolean;
44
+ /**
45
+ * You can optionally supply a list of elements that should be selected initially. This is only used if isSelectionMode is true.
46
+ */
18
47
  initiallySelectedElements?: SelectedElement[];
19
- textWords?: ITextWords;
48
+ /**
49
+ * You can supply a map of strings to be used for the text in the tree. This allows you to translate the text in the tree to other languages. There are also 'DEFAULT_TEXT_WORDS' and 'germanTextsAva' supplied with the package. You may optionally just submit the string values 'en' or 'de' to use the default text words for English or German.
50
+ */
51
+ textWords?: ITextWords | 'en' | 'de';
52
+ /**
53
+ * Defaults to true. If this is enabled, then navigating in the tree with the keyboard only works if the mouse is over the tree area. This limitation is useful if you have multiple trees or other components that might be using keyboard input.
54
+ */
20
55
  mouseAwareKeyboardControl?: boolean;
56
+ /**
57
+ * With this parameter, you can configure which keys will be listenend to to switch the tree elements, and also to disable the functionality of the keys
58
+ */
21
59
  customKeyboardOperationConfig?: IKeyboardOperationConfig | null;
60
+ /**
61
+ * You can supply custom filters that are processed when the filter input is changed. Default filters are used that check for short text and item number matches, and you can either add custom filters or replace the default ones.
62
+ */
22
63
  listFilterFunc?: FilterFunction[];
64
+ /**
65
+ * Optional. For table views, this allows you to add custom columns to the table.
66
+ * addTableColumns: Array of objects
67
+ * {
68
+ * name: string, // name of column
69
+ * title: string, // showed title of column
70
+ * align?: string, // optional alight: left(default) / center / right
71
+ * numberFormat?: string // optional format of number value, example: '1.2-2'
72
+ * }
73
+ */
23
74
  addTableColumns?: TableColumnType[];
75
+ /**
76
+ * This allows you to supply a list of functions that can be used to change the appearance of elements.
77
+ * They objects contain a predicate function that is evaluated, along with an option to configure the appearance of the element.
78
+ * functionView: Array of objects
79
+ * {
80
+ * name: string, // name of view part: you can add/remove it when needed
81
+ * func: (element: any, result?: any) => boolean, // this filter function calculates conditions to change the view
82
+ * view: {
83
+ * iconName?: string, // changed name of icon
84
+ * iconColor?: string, // changed color of icon
85
+ * textBold?: string, // changed weight of text
86
+ * textColor?: string // changed color of text
87
+ * }
88
+ * }
89
+ */
24
90
  functionView?: IFunctionViewLine[];
25
91
  }
26
92
  export type FilterFunction = (element: IElementDto, filter: string) => boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dangl/angular-ava",
3
- "version": "1.1.2-beta0165",
3
+ "version": "1.2.0-beta0170",
4
4
  "keywords": [
5
5
  "angular",
6
6
  "ava",