Skip to content

Commit

Permalink
[docs] Fix some broken links (#12107)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Jul 10, 2018
1 parent 48fdcd3 commit 5eee984
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/src/pages/demos/dialogs/dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ components: Dialog, DialogTitle, DialogContent, DialogContentText, DialogActions

<p class="description">Dialogs inform users about a task and can contain critical information, require decisions, or involve multiple tasks.</p>

A [Dialog](https://material.io/design/components/dialogs.html) is a type of [modal](/utils/modals) window that appears in front of app content to provide critical information or ask for a decision. Dialogs disable all app functionality when they appear, and remain on screen until confirmed, dismissed, or a required action has been taken.
A [Dialog](https://material.io/design/components/dialogs.html) is a type of [modal](/utils/modal) window that appears in front of app content to provide critical information or ask for a decision. Dialogs disable all app functionality when they appear, and remain on screen until confirmed, dismissed, or a required action has been taken.

Dialogs are purposefully interruptive, so they should be used sparingly.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/guides/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ however, the `open` / `onClose` / `onOpen` combination is used for display relat

### boolean vs enum

There are a couple of way to the variants of a component: with a *boolean*; or with an *enum*.
There are two options to design the API for the variations of a component: with a *boolean*; or with an *enum*.
For example, let's take a button that has different types. Each option has its pros and cons:

- Option 1 *boolean*:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/utils/portal/portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ components: Portal

The children of the portal component will be appended to the `container` specified.

The component is used internally by the [`Modal`](/utils/modals) component.
The component is used internally by the [`Modal`](/utils/modal) and [`Popper`](/utils/popper) components.
On the server, the content won't be rendered.
You have to wait for the client side reconciliation to see the children.

Expand Down
2 changes: 1 addition & 1 deletion packages/material-ui/src/Fade/Fade.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const styles = {
};

/**
* The Fade transition is used by the [Modal](/utils/modals) component.
* The Fade transition is used by the [Modal](/utils/modal) component.
* It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.
*/
class Fade extends React.Component {
Expand Down
3 changes: 2 additions & 1 deletion packages/material-ui/src/Grow/Grow.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ const styles = {
};

/**
* The Grow transition is used by the [Popover](/utils/popovers) component.
* The Grow transition is used by the [Tooltip](/demos/tooltips) and
* [Popover](/utils/popover) components.
* It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.
*/
class Grow extends React.Component {
Expand Down
3 changes: 3 additions & 0 deletions packages/material-ui/src/Modal/Modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ if (process.env.NODE_ENV !== 'production' && !React.createContext) {
throw new Error('Material-UI: react@16.3.0 or greater is required.');
}

/**
* This component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).
*/
class Modal extends React.Component {
mountNode = null;

Expand Down
2 changes: 1 addition & 1 deletion packages/material-ui/src/Modal/ModalManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ function removeContainerStyle(data, container) {
* @ignore - do not document.
*
* Proper state managment for containers and the modals in those containers.
* Simplified, but inspired by react-overlay's ModalManager class
* Simplified, but inspired by react-overlay's ModalManager class.
* Used by the Modal to ensure proper styling of containers.
*/
class ModalManager {
Expand Down
3 changes: 3 additions & 0 deletions packages/material-ui/src/Popper/Popper.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ function getAnchorEl(anchorEl) {
return typeof anchorEl === 'function' ? anchorEl() : anchorEl;
}

/**
* Poppers rely on the 3rd party library [Popper.js](https://github.com/FezVrasta/popper.js) for positioning.
*/
class Popper extends React.Component {
popper = null;

Expand Down
2 changes: 1 addition & 1 deletion pages/api/fade.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Fade API

<p class="description">The API documentation of the Fade React component.</p>

The Fade transition is used by the [Modal](/utils/modals) component.
The Fade transition is used by the [Modal](/utils/modal) component.
It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.

## Props
Expand Down
3 changes: 2 additions & 1 deletion pages/api/grow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ title: Grow API

<p class="description">The API documentation of the Grow React component.</p>

The Grow transition is used by the [Popover](/utils/popovers) component.
The Grow transition is used by the [Tooltip](/demos/tooltips) and
[Popover](/utils/popover) components.
It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.

## Props
Expand Down
2 changes: 1 addition & 1 deletion pages/api/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Modal API

<p class="description">The API documentation of the Modal React component.</p>


This component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).

## Props

Expand Down
2 changes: 1 addition & 1 deletion pages/api/popper.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Popper API

<p class="description">The API documentation of the Popper React component.</p>


Poppers rely on the 3rd party library [Popper.js](https://github.com/FezVrasta/popper.js) for positioning.

## Props

Expand Down

0 comments on commit 5eee984

Please sign in to comment.