docs: Add docs of link types to README

elecdeer · Jul 20, 2024 · 873c6c2 · 873c6c2
1 parent 5cf1933
commit 873c6c2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,10 @@ If `undefined` is returned, the link will not be added.
   - `label`: The label of the link.
   - `href`: The URL of the link.
   - `icon`: (Optional) The icon name in [@storybook/icons](https://main--64b56e737c0aeefed9d5e675.chromatic.com/?path=/docs/introduction--docs)
+  - `type`: (Optional) The type of the link.
+    - `"link"`: The link will be opened in the same tab.
+    - `"linkBlank"`: (default) The link will be opened in a new tab. Added target="\_blank" to the link.
+    - `"copy"`: The link will be copied to the clipboard.
   - `order`: (Optional) When order is specified, it will be sorted in ascending order. The default value is `0`.
 
 ### Preset settings provided by the addon