Skip to content

Commit

Permalink
[docs] Simplify wording for customization demo descriptions (mui#15539)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbrookes authored and oliviertassinari committed May 2, 2019
1 parent bb645a4 commit 5944550
Show file tree
Hide file tree
Showing 20 changed files with 44 additions and 47 deletions.
4 changes: 2 additions & 2 deletions docs/src/pages/demos/badges/badges.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The badge auto hides with badgeContent is zero. You can override this with the `

## Customized badges

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/badges/CustomizedBadges.js"}}
4 changes: 2 additions & 2 deletions docs/src/pages/demos/breadcrumbs/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ In the following examples, we are using two string separators, and an SVG icon.

## Customized breadcrumbs

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/breadcrumbs/CustomizedBreadcrumbs.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/buttons/buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ deselected, such as adding or removing a star to an item.

## Customized buttons

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/buttons/CustomizedButtons.js"}}

Expand Down
6 changes: 4 additions & 2 deletions docs/src/pages/demos/dialogs/dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ For example, if your site prompts for potential subscribers to fill in their ema

## Customized dialogs

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

The dialog has a close button added to aide usability.

{{"demo": "pages/demos/dialogs/CustomizedDialogs.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/expansion-panels/expansion-panels.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ bottlenecks first and then try out these optimization strategies.

## Customized expansion panels

If you have read the [overrides documentation page](/customization/overrides/)
but you are not confident jumping in, here is an example of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/expansion-panels/CustomizedExpansionPanels.js"}}
6 changes: 3 additions & 3 deletions docs/src/pages/demos/menus/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ The primary responsibility of the `MenuList` component is to handle the focus.

## Customized menus

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/menus/CustomizedMenus.js"}}

Expand All @@ -61,7 +61,7 @@ You can use the `Typography` component with `noWrap` to workaround this issue:

{{"demo": "pages/demos/menus/TypographyMenu.js"}}

## Change Transition
## Change transition

Use a different transition.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/progress/progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ function Progress(props) {

## Customized progress bars

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/progress/CustomizedProgressBars.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/selects/selects.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ we allow such pattern.

## Customized selects

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

The first step is to style the `InputBase` component.
Once it's styled, you can either use it directly as a text field or provide it to the select `input` property to have a select field.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/snackbars/snackbars.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ A basic snackbar that aims to reproduce Google Keep's snackbar behavior.

## Customized snackbars

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/snackbars/CustomizedSnackbars.js"}}

Expand Down
7 changes: 3 additions & 4 deletions docs/src/pages/demos/steppers/steppers.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,10 @@ Labels can be placed below the step icon by setting the `alternativeLabel` prope

{{"demo": "pages/demos/steppers/VerticalLinearStepper.js"}}

## Customized Steppers
## Customized Stepper

If you have read the [overrides documentation page](/customization/overrides/)
but you are not confident jumping in,
here are examples of how you can change the look of a stepper.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

This component uses a customized `StepConnector` element that changes border color based on the `active` and `completed` state.

Expand Down
3 changes: 2 additions & 1 deletion docs/src/pages/demos/switches/CustomizedSwitches.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ const AntSwitch = withStyles(theme => ({
width: 28,
height: 16,
padding: 0,
display: 'flex',
},
switchBase: {
padding: 2,
Expand Down Expand Up @@ -143,7 +144,7 @@ function CustomizedSwitches() {
<Typography component="div">
<Grid component="label" container alignItems="center" spacing={1}>
<Grid item>Off</Grid>
<Grid item>
<Grid item alignItems="center">
<AntSwitch
checked={state.checkedC}
onChange={handleChange('checkedC')}
Expand Down
3 changes: 2 additions & 1 deletion docs/src/pages/demos/switches/CustomizedSwitches.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ const AntSwitch = withStyles(theme => ({
width: 28,
height: 16,
padding: 0,
display: 'flex',
},
switchBase: {
padding: 2,
Expand Down Expand Up @@ -151,7 +152,7 @@ function CustomizedSwitches() {
<Typography component="div">
<Grid component="label" container alignItems="center" spacing={1}>
<Grid item>Off</Grid>
<Grid item>
<Grid item alignItems="center">
<AntSwitch
checked={state.checkedC}
onChange={handleChange('checkedC')}
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/switches/switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ However, we encourage you to use a [Checkbox](#checkboxes) instead.

## Customized switches

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/switches/CustomizedSwitches.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/tables/tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ The Table has been given a fixed width to demonstrate horizontal scrolling. In o

## Customized tables

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/tables/CustomizedTables.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/tabs/tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ Left and right scroll buttons will never be presented. All scrolling must be in

## Customized tabs

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/tabs/CustomizedTabs.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/text-fields/text-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ The component takes care of the most used properties, then it's up to the user t

## Customized inputs

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/text-fields/CustomizedInputs.js"}}

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/demos/tooltips/tooltips.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ They don’t have directional arrows; instead, they rely on motion emanating fro

## Customized tooltips

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here are some examples of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/demos/tooltips/CustomizedTooltips.js"}}

Expand Down
7 changes: 2 additions & 5 deletions docs/src/pages/lab/slider/CustomizedSlider.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@ const useStyles = makeStyles({
});

const StyledSlider = withStyles({
container: {
overflow: 'visible',
},
thumb: {
height: 32,
width: 32,
height: 24,
width: 24,
backgroundColor: '#fff',
border: '2px solid #de235b',
'&$focused, &:hover': {
Expand Down
7 changes: 2 additions & 5 deletions docs/src/pages/lab/slider/CustomizedSlider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@ const useStyles = makeStyles({
});

const StyledSlider = withStyles({
container: {
overflow: 'visible',
},
thumb: {
height: 32,
width: 32,
height: 24,
width: 24,
backgroundColor: '#fff',
border: '2px solid #de235b',
'&$focused, &:hover': {
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/lab/slider/slider.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Sliders reflect the current state of the settings they control.

## Customized sliders

If you have read the [overrides documentation page](/customization/overrides/)
and you are still not confident jumping in, here are some examples of how you can customize the component.
Here is an example of customizing the component. You can learn more about this in the
[overrides documentation page](/customization/overrides/).

{{"demo": "pages/lab/slider/CustomizedSlider.js"}}

Expand Down

0 comments on commit 5944550

Please sign in to comment.