Skip to content

Commit

Permalink
further language tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
VanAnderson committed Mar 5, 2021
1 parent 03e8cbf commit d204e73
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/content/BorderBox.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: BorderBox
---

BorderBox is a Box component with a border. When no `borderColor` is present, the component defaults to a gray border.
BorderBox is a Box component with a border. When no `borderColor` is present, the component defaults to a primary border.

## Default example

Expand Down
11 changes: 5 additions & 6 deletions docs/content/BranchName.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: BranchName
---


BranchName is a label-type component rendered as an `<a>` tag by default with monospace font and blue background.
BranchName is a label-type component rendered as an `<a>` tag by default with monospace font.

## Default example

Expand All @@ -17,7 +16,7 @@ BranchName components get `COMMON` system props. Read our [System Props](/system

## Component props

| Name | Type | Default | Description |
| :- | :- | :-: | :- |
| as | String | `<a>` | sets the HTML tag for the component |
| href | String | | a URL to link the component to |
| Name | Type | Default | Description |
| :--- | :----- | :-----: | :---------------------------------- |
| as | String | `<a>` | sets the HTML tag for the component |
| href | String | | a URL to link the component to |
2 changes: 1 addition & 1 deletion docs/content/LabelGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The LabelGroup component is used to add commonly used margins and wrapping for g
```jsx live
<LabelGroup>
<Label>Default label</Label>
<Label bg="prState.closed.bg">Label with red background</Label>
<Label bg="prState.closed.bg">Label with background indicating a closed PR state</Label>
<Label outline>Default outline label</Label>
</LabelGroup>
```
Expand Down
16 changes: 8 additions & 8 deletions docs/content/Link.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Link
---

The Link component styles anchor tags with default blue styling and hover text decoration. `Link` is used for destinations, or moving from one page to another.
The Link component styles anchor tags with default hyperlink color cues and hover text decoration. `Link` is used for destinations, or moving from one page to another.

In special cases where you'd like a `<button>` styled like a `Link`, use `<Link as='button'>`. Make sure to provide a click handler with `onClick`.

Expand All @@ -22,10 +22,10 @@ Link components get `COMMON` and `TYPOGRAPHY` system props. Read our [System Pro

## Component props

| Name | Type | Default | Description |
| :-------- | :------ | :-----: | :------------------------------------------------ |
| href | String | | URL to be used for the Link |
| muted | Boolean | false | Uses light gray for Link color, and blue on hover |
| underline | Boolean | false | Adds underline to the Link |
| as | String | 'a' | Can be 'a', 'button', 'input', or 'summary' |
| hoverColor | String | | Color used when hovering over link |
| Name | Type | Default | Description |
| :--------- | :------ | :-----: | :------------------------------------------------------------------------------ |
| href | String | | URL to be used for the Link |
| muted | Boolean | false | Uses a less prominent shade for Link color, and the default link shade on hover |
| underline | Boolean | false | Adds underline to the Link |
| as | String | 'a' | Can be 'a', 'button', 'input', or 'summary' |
| hoverColor | String | | Color used when hovering over link |
20 changes: 9 additions & 11 deletions docs/content/Tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@
title: Tooltip
---

The Tooltip component adds a tooltip to add context to elements on the page. The Tooltip has a black background by default.
The Tooltip component adds a tooltip to add context to elements on the page.

***⚠️ Usage warning! ⚠***
**_⚠️ Usage warning! ⚠_**

Tooltips as a UI pattern should be our last resort for conveying information because it is hidden by default and often with zero or little visual indicator of its existence.

Before adding a tooltip, please consider: Is this information essential and necessary? Can the UI be made clearer? Can the information be shown on the page by default?

**Attention:** we use aria-label for tooltip contents, because it is crucial that they are accessible to screen reader users. However, aria-label replaces the text content of an element in screen readers, so only use Tooltip on elements with no existing text content, or consider using `title` for supplemental information.



## Default example

```jsx live
Expand All @@ -28,10 +26,10 @@ Tooltip components get `COMMON` system props. Read our [System Props](/system-pr

## Component props

| Name | Type | Default | Description |
| :- | :- | :-: | :- |
| align | String | | Can be either `left` or `right`.|
| direction | String | | Can be one of `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw` | Sets where the tooltip renders in relation to the target. |
| noDelay | Boolean | | When set to `true`, tooltip appears without any delay |
| aria-label | String | | Text used in `aria-label` (for accessibility).
| wrap | Boolean | | Use `true` to allow text within tooltip to wrap.
| Name | Type | Default | Description |
| :--------- | :------ | :-----: | :------------------------------------------------------- | --------------------------------------------------------- |
| align | String | | Can be either `left` or `right`. |
| direction | String | | Can be one of `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw` | Sets where the tooltip renders in relation to the target. |
| noDelay | Boolean | | When set to `true`, tooltip appears without any delay |
| aria-label | String | | Text used in `aria-label` (for accessibility). |
| wrap | Boolean | | Use `true` to allow text within tooltip to wrap. |

0 comments on commit d204e73

Please sign in to comment.