Skip to content

Commit

Permalink
[docs][material-ui] Rename themed components doc, fix typos (mui#39368)
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelsycamore authored Oct 10, 2023
1 parent f3da5be commit 7f9c09f
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating themed components

<p class="description">Create your own themeable component with Joy UI theming feature.</p>
<p class="description">Learn how to create fully custom components that accept your app's theme.</p>

## Introduction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Themeable component
# Creating themed components

<p class="description">Create your own themeable component with Material UI theming feature.</p>
<p class="description">Learn how to create fully custom components that accept your app's theme.</p>

## Introduction

Material UI provides a powerful theming feature that lets you add your own components to the theme and treat them as if they're built-in components.

If you are building a component library on top of Joy UI, you can follow the step-by-step guide below to create a custom component that is themeable across multiple projects.
If you are building a component library on top of Material UI, you can follow the step-by-step guide below to create a custom component that is themeable across multiple projects.

Alternatively, you can use the provided [template](#template) as a starting point for your component.

Expand All @@ -16,7 +16,7 @@ You don't need to connect your component to the theme if you are only using it i

## Step-by-step guide

This guide will walk you through how to build this statistics component, which accepts the app's theme as though it were a built-in Joy UI component:
This guide will walk you through how to build this statistics component, which accepts the app's theme as though it were a built-in Material UI component:

{{"demo": "StatComponent.js", "hideToolbar": true}}

Expand Down
5 changes: 4 additions & 1 deletion docs/data/material/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,10 @@ const pages: MuiPage[] = [
title: 'How-to guides',
children: [
{ pathname: '/material-ui/guides/api', title: 'API design approach' },
{ pathname: '/material-ui/guides/themeable-component', title: 'Themeable component' },
{
pathname: '/material-ui/guides/creating-themed-components',
title: 'Creating themed components',
},
{ pathname: '/material-ui/guides/understand-mui-packages', title: 'Understand MUI packages' },
{ pathname: '/material-ui/guides/typescript', title: 'TypeScript' },
{ pathname: '/material-ui/guides/interoperability', title: 'Style library interoperability' },
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import * as pageProps from 'docs/data/material/guides/themeable-component/themeable-component.md?@mui/markdown';
import * as pageProps from 'docs/data/material/guides/creating-themed-components/creating-themed-components.md?@mui/markdown';

export default function Page() {
return <MarkdownDocs {...pageProps} />;
Expand Down
1 change: 1 addition & 0 deletions docs/public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ https://v4.material-ui.com/* https://v4.mui.com/:splat 301!
/material-ui/api/tree-view/ /x/api/tree-view/tree-view/ 301
/material-ui/api/tree-item/ /x/api/tree-view/tree-item/ 301
/material-ui/guides/styled-engine/ /material-ui/guides/styled-components/ 301
/material-ui/guides/themeable-component/ /material-ui/guides/creating-themed-components/ 301

# Proxies

Expand Down
2 changes: 1 addition & 1 deletion docs/translations/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@
"/material-ui/customization/how-to-customize": "How to customize",
"/material-ui/customization/color": "Color",
"/material-ui/guides": "How-to guides",
"/material-ui/guides/themeable-component": "Themeable component",
"/material-ui/guides/creating-themed-components": "Creating themed components",
"/material-ui/guides/understand-mui-packages": "Understand MUI packages",
"/material-ui/guides/typescript": "TypeScript",
"/material-ui/guides/interoperability": "Style library interoperability",
Expand Down

0 comments on commit 7f9c09f

Please sign in to comment.