Skip to content

Commit ab416e2

Browse files
committed
chore(many): remove hash symbol from internal links
INSTUI-4750
1 parent bfef92b commit ab416e2

File tree

65 files changed

+183
-132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+183
-132
lines changed

docs/contributor-docs/api-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ order: 4
88

99
### Component Properties
1010

11-
- All components should pass through additional props down to the root DOM element using the `passthroughProps` utility. (e.g. `<div {...passthroughProps(this.props)}>`). Note that in addition to allowing only valid DOM node attributes, `passthroughProps` will remove the `className` and `style` props to prevent unexpected style issues. These need to be set explicitly and used with caution. It also removes the `styles` and `makesStyles` properties added by the [withStyle](#withStyle) decorator.
11+
- All components should pass through additional props down to the root DOM element using the `passthroughProps` utility. (e.g. `<div {...passthroughProps(this.props)}>`). Note that in addition to allowing only valid DOM node attributes, `passthroughProps` will remove the `className` and `style` props to prevent unexpected style issues. These need to be set explicitly and used with caution. It also removes the `styles` and `makesStyles` properties added by the [withStyle](withStyle) decorator.
1212
- Avoid props that could be computed from other props. (e.g. prefer `<Select filter={handleFilter} />` over `<Select shouldFilter filter={handleFilter} />`. Prefer determining whether filtering should happen based on the presence of the `filter` function prop.)
1313
- Avoid situations where certain prop combinations are not supported. Prefer splitting the component into separate components with fewer props or using `PropTypes.oneOf`.
1414
- Set default prop values for non-required props when possible.
@@ -48,7 +48,7 @@ order: 4
4848

4949
- In the `styles.js`, use the name of the component in camelCase (e.g. `appNav`) as the key of the root element's style object. Use camelCase for the keys of child elements as well (e.g. `list` and `listItem`).
5050
- All style object names should be semantic (describe the content, not what it looks like).
51-
- We make use of the `label` property of [Emotion.js](https://emotion.sh/) so that it gets displayed in the generated class name for easy readability and targetability. We use a naming convention based on [BEM naming convention](#http://getbem.com/naming/):
51+
- We make use of the `label` property of [Emotion.js](https://emotion.sh/) so that it gets displayed in the generated class name for easy readability and targetability. We use a naming convention based on [BEM naming convention](http://getbem.com/naming/):
5252
- For the root element, add a label with the name of the component in camelCase \
5353
(e.g. `appNav: { label: 'appNav' }`).
5454
- For the child elements, use the double underscore separator to indicate the parent-child relation with the `[rootElementName]__[childName}` format \

docs/contributor-docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ constructed from the existing ones. For these reasons adding a new component has
2323

2424
### Building InstUI from the source
2525

26-
Please follow the steps on the [how to build guide page](#building-instui).
26+
Please follow the steps on the [how to build guide page](building-instui).
2727

2828
### Running the documentation app
2929

@@ -41,7 +41,7 @@ Please follow the steps on the [how to build guide page](#building-instui).
4141

4242
### Testing
4343

44-
See the [testing documentation](#testing-components) for details.
44+
See the [testing documentation](testing-components) for details.
4545

4646
### Linters and Code Formatting
4747

@@ -119,6 +119,6 @@ Please update the documentation and examples with any changes.
119119

120120
All components should:
121121

122-
1. Be accessible (See the [accessibility requirements](#accessibility) for more information).
122+
1. Be accessible (See the [accessibility requirements](accessibility) for more information).
123123
1. Support RTL languages.
124124
1. Localize all dates, times, numbers and strings (or require localized content passed in via props).

docs/contributor-docs/theming/theming-basics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ It accepts a `theme` prop, which should be an Instructure UI theme.
3232

3333
It can be used in two ways. On the top level, you can provide the theme for the whole application or nested anywhere inside it. You can also provide an object with theme or component theme overrides.
3434

35-
**For detailed usage info and examples, see the [InstUISettingsProvider](#InstUISettingsProvider) documentation page.**
35+
**For detailed usage info and examples, see the [InstUISettingsProvider](InstUISettingsProvider) documentation page.**
3636

3737
```jsx
3838
---
@@ -53,13 +53,13 @@ const RenderApp = () => {
5353

5454
### Theme overrides
5555

56-
A themeable component’s theme can be configured by wrapping it in an [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set explicitly via its `themeOverride` prop.
56+
A themeable component’s theme can be configured by wrapping it in an [InstUISettingsProvider](InstUISettingsProvider) component, and/or set explicitly via its `themeOverride` prop.
5757

5858
#### themeOverride prop
5959

6060
The themeable components accept a `themeOverride` prop which lets you override it's component theme object. It accepts an override object or a function, which has the current `componentTheme` as its parameter.
6161

62-
**See more on the [withStyle](#withStyle/#applying-themes) and [Using theme overrides](/#using-theme-overrides) doc pages for more info.**
62+
**See more on the [withStyle](withStyle/#applying-themes) and [Using theme overrides](/#using-theme-overrides) doc pages for more info.**
6363

6464
```js
6565
---

docs/contributor-docs/theming/theming-class-based.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 3
66

77
## Making class-based themed components
88

9-
Make a component themeable with the [withStyle](#withStyle) decorator. It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props.
9+
Make a component themeable with the [withStyle](withStyle) decorator. It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props.
1010

1111
Import the style generator (`generateStyle`) from `styles.js` and the component theme generator (`generateComponentTheme`) from `theme.js`, and pass them to the decorator.
1212

@@ -87,14 +87,14 @@ const generateComponentTheme = (theme) => {
8787
export default generateComponentTheme
8888
```
8989
90-
The arguments to the generator function are the [global theme variables](#canvas). In the above example, we've defined the default theme for the Button component.
90+
The arguments to the generator function are the [global theme variables](canvas). In the above example, we've defined the default theme for the Button component.
9191
9292
The purpose of the generator function is to take the global variables and apply them as values to the functional component level variables.
9393
When coming up with names for the component level variables, try to make them describe how they are used in the component (vs describing the variable value).
9494
9595
### Supporting multiple themes
9696
97-
If we want to make the Button transform the global theme variables differently with another theme, (e.g. [canvas-high-contrast](#canvas-high-contrast)) we can make specific styling for that theme:
97+
If we want to make the Button transform the global theme variables differently with another theme, (e.g. [canvas-high-contrast](canvas-high-contrast)) we can make specific styling for that theme:
9898
9999
```js
100100
---
@@ -134,7 +134,7 @@ The rest of the variables will pick up from the default Button theme generator (
134134
135135
In the `styles.js` file, the `generateStyle` method receives the theme variable object (`componentTheme`) generated by `theme.js`.
136136
137-
Add your styling for each element in the component, and give them [labels](https://emotion.sh/docs/labels#gatsby-focus-wrapper) for easy readability and targetability. _Naming convention_: similar to [BEM naming convention](#http://getbem.com/naming/), use the name of the component in camelCase for the root element ('button'), and the double underscore suffix for children ('button\_\_icon').
137+
Add your styling for each element in the component, and give them [labels](https://emotion.sh/docs/labels#gatsby-focus-wrapper) for easy readability and targetability. _Naming convention_: similar to [BEM naming convention](http://getbem.com/naming/), use the name of the component in camelCase for the root element ('button'), and the double underscore suffix for children ('button\_\_icon').
138138
139139
Use [Emotion's Object Styles documentation](https://emotion.sh/docs/object-styles) as a guide to add styles.
140140

docs/contributor-docs/theming/theming-functional.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 2
77
## Making InstUI-like components with theming
88

99
InstUI uses [Emotion](https://emotion.sh/docs/introduction) under the hood to theme and style its components.
10-
If you want to read about the design behind the system and how to build `class-based` components with InstUI, please read [this](#theming-class-based).
10+
If you want to read about the design behind the system and how to build `class-based` components with InstUI, please read [this](theming-class-based).
1111

1212
This page will show you how to build `functional` react components with InstUI.
1313

docs/contributor-docs/upgrade-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We recommend upgrading your application for each major version gradually, e.g. i
2222
then migrate first to the latest 9.x and then to version 10.
2323

2424
The places where your code can break during the upgrade are related to theme overrides, color props and color utilities.
25-
Please check the [theming components](#theming-components) guide to understand the new color system.
25+
Please check the [theming components](theming-components) guide to understand the new color system.
2626

2727
If you override the theme colors, you must use the new colors provided either in the `canvas-high-contrast` or in the `canvas` theme object.
2828
The previous color system has been removed, the old color names are no longer available.
@@ -53,7 +53,7 @@ If you had component level overrides of colors you need to migrate using the fol
5353
| `colors.porcelain` | `colors.contrasts.grey1111` |
5454
| `colors.white` | `colors.contrasts.white1010` |
5555

56-
You can use the latest [codemod](#ui-codemods) to automate this process.
56+
You can use the latest [codemod](ui-codemods) to automate this process.
5757

5858
InstUI v9:
5959

docs/contributor-docs/v11-upgrade-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ isWIP: true
1515

1616
### Table
1717

18-
[Table](/#Table) is now using [TableContext](#TableContext) to pass down data to its child components, the following props are no longer passed down to their children (This should only affect you if you wild custom table rows or cells):
18+
[Table](/#Table) is now using [TableContext](TableContext) to pass down data to its child components, the following props are no longer passed down to their children (This should only affect you if you wild custom table rows or cells):
1919

2020
| Component | prop | Substitute / Notes |
2121
| --------- | ----------- | ------------------------------- |

docs/getting-started/accessibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We aim to make our software accessible to everyone, including those with vision,
1111

1212
### Color Contrast
1313

14-
Our [default theme](#canvas) colors meet meets WCAG 2.1 AA rules for color contrast, and our [high contrast theme](#canvas-high-contrast) meets WCAG 2.1 AAA rules for color contrast. This ensures sufficient color contrast between elements so that users with low vision or color blindness can view and use our components.
14+
Our [default theme](canvas) colors meet meets WCAG 2.1 AA rules for color contrast, and our [high contrast theme](canvas-high-contrast) meets WCAG 2.1 AAA rules for color contrast. This ensures sufficient color contrast between elements so that users with low vision or color blindness can view and use our components.
1515

1616
### Keyboard Navigation
1717

docs/getting-started/theming-components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ relevantForAI: true
77

88
## Themes
99

10-
Instructure UI ships with two built-in themes: [canvas theme](#canvas) (default), [high contrast canvas theme](#canvas-high-contrast).
10+
Instructure UI ships with two built-in themes: [canvas theme](canvas) (default), [high contrast canvas theme](canvas-high-contrast).
1111
They are meant to be used together, `canvas` provides 4.5:1 contrast, while `canvas-high-contrast` 7.0:1.
1212

13-
You can change the theme used with the [InstUISettingsProvider](#InstUISettingsProvider) component:
13+
You can change the theme used with the [InstUISettingsProvider](InstUISettingsProvider) component:
1414

1515
```jsx
1616
---
@@ -29,7 +29,7 @@ render() {
2929
For more details on how to customize themes or apply different ones to parts of you application see [Using Theme Overrides](/#using-theme-overrides).
3030

3131
If you are interested in how InstUI's theming engine works and/or you want to make your own components that use the themes,
32-
read our documentation on the theming engine [here](#theming-basics).
32+
read our documentation on the theming engine [here](theming-basics).
3333

3434
## Colors
3535

docs/getting-started/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ export default App
6464

6565
What does this code do?
6666

67-
- [InstUISettingsProvider](#InstUISettingsProvider) allows to specify the text direction (default is the direction that the user's browser supplies) and the theme to your application. InstUI components require a theme to work, all components are themeable, and themes control their look and feel. There are 2 built-in themes: [`canvas`](#canvas) and [`canvasHighContrast`](#canvas-high-contrast). The component examples seen throughout the documentation use the [canvas theme](#canvas) by default.
68-
- [Button](#Button) is an Instructure UI button component
67+
- [InstUISettingsProvider](InstUISettingsProvider) allows to specify the text direction (default is the direction that the user's browser supplies) and the theme to your application. InstUI components require a theme to work, all components are themeable, and themes control their look and feel. There are 2 built-in themes: [`canvas`](canvas) and [`canvasHighContrast`](canvas-high-contrast). The component examples seen throughout the documentation use the [canvas theme](canvas) by default.
68+
- [Button](Button) is an Instructure UI button component
6969

7070
Finally, run `npm run dev` to start up a basic development server.
7171

@@ -91,5 +91,5 @@ https://instructure.design/llms.txt
9191

9292
## Further reading
9393

94-
- To use a different theme or customize one read about [Using theme overrides](#using-theme-overrides)
95-
- Make sure you read about [Accessibility](#accessibility) with InstUI.
94+
- To use a different theme or customize one read about [Using theme overrides](using-theme-overrides)
95+
- Make sure you read about [Accessibility](accessibility) with InstUI.

0 commit comments

Comments
 (0)