@polarityio/pi-external-link 1.0.4 → 1.0.6

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,6 +1,6 @@
1
1
  {
2
2
  "pi-external-link": {
3
- "element": "pi-external-link-v1-0-4",
3
+ "element": "pi-external-link-v1-0-6",
4
4
  "className": "PiExternalLink",
5
5
  "package": "@polarityio/pi-external-link"
6
6
  }
@@ -14,9 +14,16 @@ export interface PiExternalLinkProps {
14
14
  * @slot tooltip - Custom tooltip content (overrides default tooltip)
15
15
  * @cssproperty [--pi-external-link-icon-size=0.85em] - Override the link icon size
16
16
  * @cssproperty [--pi-external-link-icon-color=currentColor] - Override the link icon color
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <pi-external-link href="https://example.com" text="Visit Example"></pi-external-link>
21
+ * ```
17
22
  */
18
23
  export declare class PiExternalLink extends LitElement {
24
+ /** The URL the link points to. When empty, the component renders nothing. */
19
25
  href: string;
26
+ /** Display text for the link. Defaults to the `href` value when not set. */
20
27
  text: string;
21
28
  /** Hide the external-link icon */
22
29
  noIcon: boolean;
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@ import { faUpRightFromSquare } from "@fortawesome/free-solid-svg-icons";
5
5
  import { defineCustomElementOnce, libraryCustomElementName } from "@polarityio/pi-shared";
6
6
  import { CUSTOM_ELEMENT_NAME as CUSTOM_ELEMENT_NAME$1, PiIcon } from "@polarityio/pi-icon";
7
7
  import { CUSTOM_ELEMENT_NAME as CUSTOM_ELEMENT_NAME$2, PiTooltip } from "@polarityio/pi-tooltip";
8
- const version = "1.0.4";
8
+ const version = "1.0.6";
9
9
  const packageJson = {
10
10
  version
11
11
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@polarityio/pi-external-link",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "External link component that opens in a new tab with icon and tooltip",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -29,9 +29,9 @@
29
29
  ],
30
30
  "dependencies": {
31
31
  "@fortawesome/free-solid-svg-icons": "^7.0.0",
32
- "@polarityio/pi-shared": "1.2.1",
33
- "@polarityio/pi-icon": "1.0.3",
34
- "@polarityio/pi-tooltip": "1.0.5"
32
+ "@polarityio/pi-shared": "1.3.3",
33
+ "@polarityio/pi-icon": "1.0.4",
34
+ "@polarityio/pi-tooltip": "1.0.6"
35
35
  },
36
36
  "peerDependencies": {
37
37
  "lit": "^3.0.0"