@record-evolution/widget-navbutton 1.0.6 → 1.0.7

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.
Files changed (4) hide show
  1. package/dist/widget-navbutton.js +2 -2
  2. package/package.json +1 -1
  3. package/src/definition-schema.d.ts +20 -5
  4. package/src/definition-schema.json +10 -5
package/dist/widget-navbutton.js CHANGED
@@ -10,7 +10,7 @@ var f = Object.defineProperty, b = Object.getOwnPropertyDescriptor, s = (t, e, o
10
10
  };
11
11
  let r = class extends d {
12
12
  constructor() {
13
- super(...arguments), this.version = "1.0.6";
13
+ super(...arguments), this.version = "1.0.7";
14
14
  }
15
15
  update(t) {
16
16
  t.has("theme") && this.registerTheme(this.theme), super.update(t);
@@ -98,7 +98,7 @@ s([
98
98
  p()
99
99
  ], r.prototype, "themeTitleColor", 2);
100
100
  r = s([
101
- u("widget-navbutton-1.0.6")
101
+ u("widget-navbutton-1.0.7")
102
102
  ], r);
103
103
  export {
104
104
  r as WidgetNavbutton
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "description": "Webcomponent widget-navbutton following open-wc recommendations",
4
4
  "license": "MIT",
5
5
  "author": "widget-navbutton",
6
- "version": "1.0.6",
6
+ "version": "1.0.7",
7
7
  "engines": {
8
8
  "node": ">=24.9.0",
9
9
  "npm": ">=10.0.2"
package/src/definition-schema.d.ts CHANGED
@@ -5,28 +5,34 @@
5
5
  * and run json-schema-to-typescript to regenerate this file.
6
6
  */
7
7
 
8
+ /**
9
+ * The text displayed on the button. Should be short and action-oriented (e.g., 'Go Back', 'View Details', 'Open Settings').
10
+ */
8
11
  export type Label = string;
9
12
  /**
10
- * Name of the icon from https://fonts.google.com/icons
13
+ * Material icon name displayed alongside the label. Find icon names at https://fonts.google.com/icons (e.g., 'arrow_back', 'open_in_new', 'settings', 'home').
11
14
  */
12
15
  export type IconName = string;
13
16
  /**
14
- * Navigation to perform on button click. Leave blank to perform automatic back navigation. Example: If you are at route /my/route/asset then 'settings/profile' routes to '/my/route/settings/profile'.
17
+ * The destination path when the button is clicked. Leave blank to perform automatic browser back navigation. Use relative paths (e.g., 'details', '../overview') or enable leadingSlash for absolute paths from root.
15
18
  */
16
19
  export type Navigation = string;
17
20
  /**
18
- * Whether to add a leading slash to the navigation route.
21
+ * When enabled, prepends '/' to the navigation route making it absolute from the root. When disabled, routes are relative to the current URL location.
19
22
  */
20
23
  export type AddLeadingSlash = boolean;
21
24
  /**
22
- * Whether to add a trailing slash to the navigation route.
25
+ * When enabled, appends '/' to the end of the navigation route. Required by some routing configurations for proper page matching.
23
26
  */
24
27
  export type AddTraillingSlash = boolean;
25
28
  /**
26
- * Font size in pixels
29
+ * Font size in pixels for the button label text.
27
30
  */
28
31
  export type FontSize = number;
29
32
 
33
+ /**
34
+ * A navigation button widget for in-dashboard navigation between pages or sections. Use this widget to create clickable buttons that navigate users to different dashboard views, external pages, or perform back navigation. Supports Material Design icons and customizable styling. Ideal for creating navigation flows, back buttons, call-to-action links, or any clickable element that should route users to another location.
35
+ */
30
36
  export interface InputData {
31
37
  title?: Label;
32
38
  iconName?: IconName;
@@ -36,15 +42,24 @@ export interface InputData {
36
42
  style?: ButtonStyle;
37
43
  [k: string]: unknown;
38
44
  }
45
+ /**
46
+ * Visual styling options for the button appearance.
47
+ */
39
48
  export interface ButtonStyle {
40
49
  fontSize?: FontSize;
41
50
  color?: FontColor;
42
51
  backgroundColor?: BackgroundColor;
43
52
  [k: string]: unknown;
44
53
  }
54
+ /**
55
+ * Text color for the button label and icon.
56
+ */
45
57
  export interface FontColor {
46
58
  [k: string]: unknown;
47
59
  }
60
+ /**
61
+ * Background fill color of the button.
62
+ */
48
63
  export interface BackgroundColor {
49
64
  [k: string]: unknown;
50
65
  }
package/src/definition-schema.json CHANGED
@@ -1,59 +1,64 @@
1
1
  {
2
2
  "title": "Input Data",
3
+ "description": "A navigation button widget for in-dashboard navigation between pages or sections. Use this widget to create clickable buttons that navigate users to different dashboard views, external pages, or perform back navigation. Supports Material Design icons and customizable styling. Ideal for creating navigation flows, back buttons, call-to-action links, or any clickable element that should route users to another location.",
3
4
  "type": "object",
4
5
  "properties": {
5
6
  "title": {
6
7
  "title": "Label",
8
+ "description": "The text displayed on the button. Should be short and action-oriented (e.g., 'Go Back', 'View Details', 'Open Settings').",
7
9
  "order": 1,
8
10
  "type": "string"
9
11
  },
10
12
  "iconName": {
11
13
  "title": "Icon Name",
12
14
  "order": 2,
13
- "description": "Name of the icon from https://fonts.google.com/icons",
15
+ "description": "Material icon name displayed alongside the label. Find icon names at https://fonts.google.com/icons (e.g., 'arrow_back', 'open_in_new', 'settings', 'home').",
14
16
  "dataDrivenDisabled": true,
15
17
  "type": "string"
16
18
  },
17
19
  "route": {
18
20
  "title": "Navigation",
19
21
  "order": 3,
20
- "description": "Navigation to perform on button click. Leave blank to perform automatic back navigation. Example: If you are at route /my/route/asset then 'settings/profile' routes to '/my/route/settings/profile'.",
22
+ "description": "The destination path when the button is clicked. Leave blank to perform automatic browser back navigation. Use relative paths (e.g., 'details', '../overview') or enable leadingSlash for absolute paths from root.",
21
23
  "type": "string"
22
24
  },
23
25
  "leadingSlash": {
24
26
  "title": "Add Leading Slash",
25
27
  "order": 4,
26
- "description": "Whether to add a leading slash to the navigation route.",
28
+ "description": "When enabled, prepends '/' to the navigation route making it absolute from the root. When disabled, routes are relative to the current URL location.",
27
29
  "dataDrivenDisabled": true,
28
30
  "type": "boolean"
29
31
  },
30
32
  "trailingSlash": {
31
33
  "title": "Add Trailling Slash",
32
34
  "order": 5,
33
- "description": "Whether to add a trailing slash to the navigation route.",
35
+ "description": "When enabled, appends '/' to the end of the navigation route. Required by some routing configurations for proper page matching.",
34
36
  "dataDrivenDisabled": true,
35
37
  "type": "boolean"
36
38
  },
37
39
  "style": {
38
40
  "title": "Button Style",
41
+ "description": "Visual styling options for the button appearance.",
39
42
  "order": 6,
40
43
  "type": "object",
41
44
  "properties": {
42
45
  "fontSize": {
43
46
  "title": "Font Size",
44
47
  "order": 1,
45
- "description": "Font size in pixels",
48
+ "description": "Font size in pixels for the button label text.",
46
49
  "dataDrivenDisabled": true,
47
50
  "type": "number"
48
51
  },
49
52
  "color": {
50
53
  "title": "Font Color",
54
+ "description": "Text color for the button label and icon.",
51
55
  "order": 4,
52
56
  "type": "color",
53
57
  "dataDrivenDisabled": true
54
58
  },
55
59
  "backgroundColor": {
56
60
  "title": "Background Color",
61
+ "description": "Background fill color of the button.",
57
62
  "order": 4,
58
63
  "type": "color",
59
64
  "dataDrivenDisabled": true