@limetech/lime-elements 37.2.0-next.2 → 37.2.0-next.3

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.
@@ -1,4 +1,4 @@
1
- import { Components } from '@limetech/lime-elements';
1
+ import { Help } from '../help/help.types';
2
2
  import { EventEmitter } from '../../stencil-public-runtime';
3
3
  export interface ValidationStatus {
4
4
  /**
@@ -139,7 +139,7 @@ export interface LimeSchemaOptions {
139
139
  * Mark the field as disabled
140
140
  */
141
141
  disabled?: boolean;
142
- help?: string | Components.LimelHelp;
142
+ help?: string | Help;
143
143
  }
144
144
  /**
145
145
  * Options for a component to be rendered inside a form
@@ -1,5 +1,6 @@
1
1
  import { OpenDirection } from '../menu/menu.types';
2
2
  import { Link } from '../../interface';
3
+ import { Help as HelpInterface } from './help.types';
3
4
  /**
4
5
  * A good design is self-explanatory! However, sometimes concepts are
5
6
  * too complex to understand, no matter how well-designed a user interface is.
@@ -21,29 +22,21 @@ import { Link } from '../../interface';
21
22
  * @exampleComponent limel-example-open-direction
22
23
  * @exampleComponent limel-example-placement
23
24
  */
24
- export declare class Help {
25
+ export declare class Help implements HelpInterface {
25
26
  /**
26
- * The markdown content that will be displayed in the popover.
27
+ * @inheritdoc
27
28
  */
28
29
  value: string;
29
30
  /**
30
- * Visualizes the trigger element. Defaults to: **?**
31
- * :::important
32
- * Be consistent across the product if you want to change it to a custom character.
33
- * All instances of the help component should have the same trigger visualization.
34
- * :::
31
+ * @inheritdoc
35
32
  */
36
33
  trigger: string;
37
34
  /**
38
- * If supplied, it will render a "Read more" link at the bottom of the content.
39
- * Even though you can add a link anywhere in the content, it is recommended to
40
- * use the read more link. Because it will always be displayed at the bottom
41
- * of the popover after the content, does not scroll away with the content,
42
- * and it will be styled in a consistent way.
35
+ * @inheritdoc
43
36
  */
44
37
  readMoreLink?: Link;
45
38
  /**
46
- * Decides the popover's location in relation to the trigger.
39
+ * @inheritdoc
47
40
  */
48
41
  openDirection: OpenDirection;
49
42
  private isOpen;
@@ -0,0 +1,28 @@
1
+ import { OpenDirection } from '../menu/menu.types';
2
+ import { Link } from '../../interface';
3
+ export interface Help {
4
+ /**
5
+ * Decides the popover's location in relation to the trigger.
6
+ */
7
+ openDirection: OpenDirection;
8
+ /**
9
+ * If supplied, it will render a "Read more" link at the bottom of the content.
10
+ * Even though you can add a link anywhere in the content, it is recommended to
11
+ * use the read more link. Because it will always be displayed at the bottom
12
+ * of the popover after the content, does not scroll away with the content,
13
+ * and it will be styled in a consistent way.
14
+ */
15
+ readMoreLink?: Link;
16
+ /**
17
+ * Visualizes the trigger element. Defaults to: **?**
18
+ * :::important
19
+ * Be consistent across the product if you want to change it to a custom character.
20
+ * All instances of the help component should have the same trigger visualization.
21
+ * :::
22
+ */
23
+ trigger: string;
24
+ /**
25
+ * The markdown content that will be displayed in the popover.
26
+ */
27
+ value: string;
28
+ }
@@ -1136,18 +1136,22 @@ export namespace Components {
1136
1136
  interface LimelHelp {
1137
1137
  /**
1138
1138
  * Decides the popover's location in relation to the trigger.
1139
+ * @inheritdoc
1139
1140
  */
1140
1141
  "openDirection": OpenDirection1;
1141
1142
  /**
1142
1143
  * If supplied, it will render a "Read more" link at the bottom of the content. Even though you can add a link anywhere in the content, it is recommended to use the read more link. Because it will always be displayed at the bottom of the popover after the content, does not scroll away with the content, and it will be styled in a consistent way.
1144
+ * @inheritdoc
1143
1145
  */
1144
1146
  "readMoreLink"?: Link;
1145
1147
  /**
1146
1148
  * Visualizes the trigger element. Defaults to: **?** :::important Be consistent across the product if you want to change it to a custom character. All instances of the help component should have the same trigger visualization. :::
1149
+ * @inheritdoc
1147
1150
  */
1148
1151
  "trigger": string;
1149
1152
  /**
1150
1153
  * The markdown content that will be displayed in the popover.
1154
+ * @inheritdoc
1151
1155
  */
1152
1156
  "value": string;
1153
1157
  }
@@ -4961,18 +4965,22 @@ declare namespace LocalJSX {
4961
4965
  interface LimelHelp {
4962
4966
  /**
4963
4967
  * Decides the popover's location in relation to the trigger.
4968
+ * @inheritdoc
4964
4969
  */
4965
4970
  "openDirection"?: OpenDirection1;
4966
4971
  /**
4967
4972
  * If supplied, it will render a "Read more" link at the bottom of the content. Even though you can add a link anywhere in the content, it is recommended to use the read more link. Because it will always be displayed at the bottom of the popover after the content, does not scroll away with the content, and it will be styled in a consistent way.
4973
+ * @inheritdoc
4968
4974
  */
4969
4975
  "readMoreLink"?: Link;
4970
4976
  /**
4971
4977
  * Visualizes the trigger element. Defaults to: **?** :::important Be consistent across the product if you want to change it to a custom character. All instances of the help component should have the same trigger visualization. :::
4978
+ * @inheritdoc
4972
4979
  */
4973
4980
  "trigger"?: string;
4974
4981
  /**
4975
4982
  * The markdown content that will be displayed in the popover.
4983
+ * @inheritdoc
4976
4984
  */
4977
4985
  "value"?: string;
4978
4986
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@limetech/lime-elements",
3
- "version": "37.2.0-next.2",
3
+ "version": "37.2.0-next.3",
4
4
  "description": "Lime Elements",
5
5
  "author": "Lime Technologies",
6
6
  "license": "Apache-2.0",