Skip to content

Commit

Permalink
Link README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
BPScott committed Sep 17, 2019
1 parent 95a1248 commit bd34507
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions src/components/Link/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Monochrome styles will be applied to links rendered within a `Banner`.

### External link

Use for text links that point to a different website. They will open in a new browser tab or window.
Use for text links that should open in a new browser tab (or window, depending on the merchant’s browser settings). Use this only when opening a page in the same tab might disrupt the merchant’s workflow.

```jsx
<Link url="https://help.shopify.com/manual" external>
Expand Down Expand Up @@ -184,7 +184,7 @@ To provide consistency and clarity:

#### External links

The `external` prop adds an icon and a notification that the link opens a new window. Use the `external` prop to make the link open in a new window (or tab, depending on the merchant’s browser settings). Open a page in a new window or tab only when opening a page in the same tab might disrupt the merchant’s workflow.
The `external` prop adds an icon and a notification that the link opens a new tab. Use the `external` prop to make the link open in a new tab (or window, depending on the merchant’s browser settings). Open a page in a new tab only when opening a page in the same tab might disrupt the merchant’s workflow.

### Keyboard support

Expand Down
2 changes: 1 addition & 1 deletion src/utilities/link/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export interface LinkLikeComponentProps
children?: React.ReactNode;
/** Makes the link open in a new tab */
external?: boolean;
/** Makes the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value. */
/** Makes the browser download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value. */
download?: string | boolean;
[key: string]: any;
}
Expand Down

0 comments on commit bd34507

Please sign in to comment.