Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs][base-ui] Add new batch of coming soon pages #38025

Merged
merged 27 commits into from
Aug 1, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
86e6a4a
add new batch of coming soon components
danilo-leal Jul 18, 2023
ad1ccd8
run yarn docs:api
danilo-leal Jul 18, 2023
41687ce
run yarn docs:i18n
danilo-leal Jul 18, 2023
5e5cef0
remove unused imports (lint error)
danilo-leal Jul 18, 2023
21d06e3
update label from Coming soon to Planned
danilo-leal Jul 19, 2023
e739197
Merge remote-tracking branch 'origin/master' into add-more-baseui-com…
danilo-leal Jul 19, 2023
e36508e
use links for the individual issues
danilo-leal Jul 19, 2023
fb0189c
add toggle button group
danilo-leal Jul 19, 2023
ae5c028
adjust copy and formatting
danilo-leal Jul 19, 2023
86ebf0b
missing line break on the tooltip
danilo-leal Jul 19, 2023
129439c
add new batch of coming soon components
danilo-leal Jul 18, 2023
25b98d7
run yarn docs:api
danilo-leal Jul 18, 2023
607cb58
run yarn docs:i18n
danilo-leal Jul 18, 2023
b729a74
remove unused imports (lint error)
danilo-leal Jul 18, 2023
4a74049
update label from Coming soon to Planned
danilo-leal Jul 19, 2023
fc43a3f
use links for the individual issues
danilo-leal Jul 19, 2023
f98df76
add toggle button group
danilo-leal Jul 19, 2023
c8ebd6a
adjust copy and formatting
danilo-leal Jul 19, 2023
d01bba9
missing line break on the tooltip
danilo-leal Jul 19, 2023
a58b098
Merge branch 'add-more-baseui-comingsoon-pages' of https://github.com…
danilo-leal Jul 31, 2023
04472e3
run yarn docs:i18n
danilo-leal Jul 31, 2023
99fe5eb
update wording around upvoting
danilo-leal Jul 31, 2023
f4fdf2a
change callout type
danilo-leal Jul 31, 2023
cc9a604
add a page for the drawer component
danilo-leal Jul 31, 2023
97e5771
run yarn docs:i18n
danilo-leal Jul 31, 2023
1d7eb49
remove dead files
oliviertassinari Jul 31, 2023
8b352b5
copywriting review
danilo-leal Aug 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/data/base/components/accordion/accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ githubLabel: 'component: accordion'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/accordion/
---

# Accordion
# Accordion 🚧

<p class="description">Accordions let users show and hide sections of related content on a page.</p>

:::info
💡 The Base UI Accordion component is still in development.
Help us prioritize the next batch of new components by sharing your needs in [this GitHub issue](https://github.com/mui/material-ui/issues/27170).
💡 The Base UI Accordion component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38037).
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved
:::
7 changes: 4 additions & 3 deletions docs/data/base/components/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ githubLabel: 'component: checkbox'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
---

# Checkbox
# Checkbox 🚧

<p class="description">Checkboxes give users binary choices when presented with multiple options in a series.</p>

:::info
💡 The Base UI Checkbox component is still in development.
Help us prioritize the next batch of new components by sharing your needs in [this GitHub issue](https://github.com/mui/material-ui/issues/27170).
💡 The Base UI Checkbox component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38036).
:::
15 changes: 15 additions & 0 deletions docs/data/base/components/pagination/pagination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
productId: base-ui
title: React Pagination component
githubLabel: 'component: Pagination'
---

# Pagination 🚧

<p class="description">The Pagination component enables the user to select a specific page from a range of pages.</p>
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved

:::info
💡 The Base UI Pagination component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38042).
:::
7 changes: 4 additions & 3 deletions docs/data/base/components/radio-button/radio-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ githubLabel: 'component: radio'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
---

# Radio Button
# Radio Button 🚧

<p class="description">Radio buttons enable the user to select one option from a set.</p>

:::info
💡 The Base UI Radio Button component is still in development.
Help us prioritize the next batch of new components by sharing your needs in [this GitHub issue](https://github.com/mui/material-ui/issues/27170).
💡 The Base UI Radio Button component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38038).
:::
16 changes: 16 additions & 0 deletions docs/data/base/components/rating/rating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
productId: base-ui
title: React Rating component
githubLabel: 'component: rating'
waiAria: https://www.w3.org/WAI/tutorials/forms/custom-controls/#a-star-rating
---

# Rating 🚧

<p class="description">Ratings provide insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own.</p>
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved

:::info
💡 The Base UI Rating component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38043).
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
productId: base-ui
title: React Toggle Button Group component
githubLabel: 'component: toggle button'
---

# Toggle Button Group 🚧

<p class="description">A Toggle Button Group houses differen buttons with mutually exclusive actions.</p>
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved

:::info
💡 The Base UI Toggle Button Group component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38044).
:::
16 changes: 16 additions & 0 deletions docs/data/base/components/tooltip/tooltip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
productId: base-ui
title: React Tooltip component
githubLabel: 'component: tooltip'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/
---

# Tooltip 🚧

<p class="description">Tooltips display informative text when users hover over, focus on, or tap an element.</p>

:::info
💡 The Base UI Tooltip component isn't implemented yet but it's planned!

Help us prioritize it by giving a thumbs up in [this GitHub issue](https://github.com/mui/material-ui/issues/38045).
:::
19 changes: 12 additions & 7 deletions docs/data/base/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,26 @@ const pages = [
children: [
{ pathname: '/base-ui/react-autocomplete', title: 'Autocomplete' },
{ pathname: '/base-ui/react-button', title: 'Button' },
{ pathname: '/base-ui/react-checkbox', title: 'Checkbox', comingSoon: true },
{ pathname: '/base-ui/react-checkbox', title: 'Checkbox', planned: true },
{ pathname: '/base-ui/react-input', title: 'Input' },
{ pathname: '/base-ui/react-radio-button', title: 'Radio Button', comingSoon: true },
{ pathname: '/base-ui/react-radio-button', title: 'Radio Button', planned: true },
{ pathname: '/base-ui/react-rating', title: 'Rating', planned: true },
{ pathname: '/base-ui/react-select', title: 'Select' },
{ pathname: '/base-ui/react-slider', title: 'Slider' },
{ pathname: '/base-ui/react-switch', title: 'Switch' },
{
pathname: '/base-ui/react-toggle-button-group',
title: 'Toggle Button Group',
planned: true,
},
],
},
{
pathname: '/base-ui/components/data-display',
subheader: 'data-display',
children: [
{
pathname: '/base-ui/react-badge',
title: 'Badge',
},
{ pathname: '/base-ui/react-badge', title: 'Badge' },
{ pathname: '/base-ui/react-tooltip', title: 'Tooltip', planned: true },
],
},
{
Expand All @@ -60,7 +64,7 @@ const pages = [
{
pathname: '/base-ui/react-accordion',
title: 'Accordion',
comingSoon: true,
planned: true,
},
],
},
Expand All @@ -69,6 +73,7 @@ const pages = [
subheader: 'navigation',
children: [
{ pathname: '/base-ui/react-menu', title: 'Menu' },
{ pathname: '/base-ui/react-pagination', title: 'Pagination', planned: true },
{ pathname: '/base-ui/react-table-pagination', title: 'Table Pagination' },
{ pathname: '/base-ui/react-tabs', title: 'Tabs' },
],
Expand Down
6 changes: 3 additions & 3 deletions docs/data/joy/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,14 @@ const pages = [
{ pathname: '/joy-ui/react-linear-progress', title: 'Linear Progress' },
{ pathname: '/joy-ui/react-modal' },
{ pathname: '/joy-ui/react-skeleton', newFeature: true },
{ pathname: '/joy-ui/react-snackbar', comingSoon: true },
{ pathname: '/joy-ui/react-snackbar', planned: true },
],
},
{
pathname: '/joy-ui/components/surfaces',
subheader: 'surfaces',
children: [
{ pathname: '/joy-ui/react-accordion', comingSoon: true },
{ pathname: '/joy-ui/react-accordion', planned: true },
{ pathname: '/joy-ui/react-card' },
{ pathname: '/joy-ui/react-sheet' },
],
Expand All @@ -92,7 +92,7 @@ const pages = [
subheader: 'navigation',
children: [
{ pathname: '/joy-ui/react-breadcrumbs' },
{ pathname: '/joy-ui/react-drawer', comingSoon: true },
{ pathname: '/joy-ui/react-drawer', planned: true },
{ pathname: '/joy-ui/react-link' },
{ pathname: '/joy-ui/react-menu' },
{ pathname: '/joy-ui/react-tabs' },
Expand Down
31 changes: 31 additions & 0 deletions docs/pages/base-ui/react-accordion/[docsTab]/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/accordion/accordion.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};

export const getStaticPaths = () => {
return {
paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }],
fallback: false, // can also be true or 'blocking'
};
};

export const getStaticProps = () => {
return {
props: {
componentsApiDescriptions: {},
componentsApiPageContents: {},
hooksApiDescriptions: {},
hooksApiPageContents: {},
},
};
};
31 changes: 31 additions & 0 deletions docs/pages/base-ui/react-checkbox/[docsTab]/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/checkbox/checkbox.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};

export const getStaticPaths = () => {
return {
paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }],
fallback: false, // can also be true or 'blocking'
};
};

export const getStaticProps = () => {
return {
props: {
componentsApiDescriptions: {},
componentsApiPageContents: {},
hooksApiDescriptions: {},
hooksApiPageContents: {},
},
};
};
31 changes: 31 additions & 0 deletions docs/pages/base-ui/react-pagination/[docsTab]/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/pagination/pagination.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};

export const getStaticPaths = () => {
return {
paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }],
fallback: false, // can also be true or 'blocking'
};
};

export const getStaticProps = () => {
return {
props: {
componentsApiDescriptions: {},
componentsApiPageContents: {},
hooksApiDescriptions: {},
hooksApiPageContents: {},
},
};
};
13 changes: 13 additions & 0 deletions docs/pages/base-ui/react-pagination/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/pagination/pagination.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};
31 changes: 31 additions & 0 deletions docs/pages/base-ui/react-radio-button/[docsTab]/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/radio-button/radio-button.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};

export const getStaticPaths = () => {
return {
paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }],
fallback: false, // can also be true or 'blocking'
};
};

export const getStaticProps = () => {
return {
props: {
componentsApiDescriptions: {},
componentsApiPageContents: {},
hooksApiDescriptions: {},
hooksApiPageContents: {},
},
};
};
31 changes: 31 additions & 0 deletions docs/pages/base-ui/react-rating/[docsTab]/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/rating/rating.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};

export const getStaticPaths = () => {
return {
paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }],
fallback: false, // can also be true or 'blocking'
};
};

export const getStaticProps = () => {
return {
props: {
componentsApiDescriptions: {},
componentsApiPageContents: {},
hooksApiDescriptions: {},
hooksApiPageContents: {},
},
};
};
13 changes: 13 additions & 0 deletions docs/pages/base-ui/react-rating/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/rating/rating.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};
13 changes: 13 additions & 0 deletions docs/pages/base-ui/react-toggle-button-group/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
import AppFrame from 'docs/src/modules/components/AppFrame';
import * as pageProps from 'docs/data/base/components/toggle-button-group/toggle-button-group.md?@mui/markdown';

export default function Page(props) {
const { userLanguage, ...other } = props;
return <MarkdownDocs {...pageProps} {...other} />;
}

Page.getLayout = (page) => {
return <AppFrame>{page}</AppFrame>;
};
Loading