Skip to content
This repository was archived by the owner on Nov 16, 2022. It is now read-only.

Commit d0fdee0

Browse files
DanilAndreevDanilAndreev
committed
[API Pages] Added several pages with new extension.
1 parent 3852fb3 commit d0fdee0

File tree

15 files changed

+381
-572
lines changed

15 files changed

+381
-572
lines changed

‎.idea/dictionaries/danil.xml‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/runConfigurations/npm_start.xml‎

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/locale/EN.json‎

Lines changed: 186 additions & 513 deletions
Large diffs are not rendered by default.

‎src/pages/APIs/DocsLayoutAPI/index.js‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,50 @@ import DocsLayout from "@material-docs/core/components/DocsLayout";
1818
export default function DocsLayoutAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.DocsLayoutAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
24+
name={"DocsLayout"}
25+
overrideName={"MatDoc-DocsLayout"}
2726
localeName={"DocsLayoutAPI"}
2827
searchTags={["docs", "layout", "main", "component", "api"]}
29-
name={"DocsLayout"}
3028
importCode={importCode}
29+
properties={[
30+
{name: "searchData", type: "SearchDataItem[]", default: "", description: locale.props.searchData},
31+
{name: "noGenerateAutoSearch", type: "boolean", default: "false", description: locale.props.noGenerateAutoSearch},
32+
{name: "defaultLang", type: "Lang", default: "", description: locale.props.defaultLang},
33+
{name: "langs", type: "Lang[]", default: "", description: locale.props.langs},
34+
{name: "onHelpToTranslate", type: "function(lang: Lang): void", default: "", description: locale.props.noTag},
35+
{name: "router", type: "\"hash-router\" | \"browser-router\"", default: "\"browser-router\"", description: locale.props.router},
36+
{name: "basename", type: "string", default: "", description: locale.props.basename},
37+
{name: "mask", type: "string", default: "\"/*page\"", description: locale.props.mask},
38+
{name: "noSearchField", type: "boolean", default: "false", description: locale.props.noSearchField},
39+
{name: "noLanguageSelector", type: "boolean", default: "false", description: locale.props.noLanguageSelector},
40+
{name: "actions", type: "AppBarAction[]", default: "[]", description: locale.props.actions},
41+
{name: "keywords", type: "string[]", default: "", description: locale.props.basename},
42+
{name: "author", type: "string", default: "", description: locale.props.author},
43+
{name: "description", type: "string", default: "", description: locale.props.description},
44+
{name: "name", type: "string", default: "", description: locale.props.name},
45+
{name: "version", type: "string", default: "", description: locale.props.version},
46+
{name: "logo", type: "string", default: "", description: locale.props.logo},
47+
{name: "children", type: "node", default: "", description: locale.props.children},
48+
]}
49+
css={[
50+
{name: "root", global: "MatDoc-root", description: locale.css.root},
51+
{name: "appBar", global: "MatDoc-appBar", description: locale.css.appBar},
52+
{name: "appBarShift", global: "MatDoc-appBarShift", description: locale.css.appBarShift},
53+
{name: "menuButton", global: "MatDoc-menuButton", description: locale.css.menuButton},
54+
{name: "hide", global: "MatDoc-hide", description: locale.css.hide},
55+
{name: "drawer", global: "MatDoc-drawer", description: locale.css.drawer},
56+
{name: "drawerPaper", global: "MatDoc-drawerPaper", description: locale.css.drawerPaper},
57+
{name: "drawerHeader", global: "MatDoc-drawerHeader", description: locale.css.drawerHeader},
58+
{name: "content", global: "MatDoc-content", description: locale.css.content},
59+
{name: "contentShift", global: "MatDoc-contentShift", description: locale.css.contentShift},
60+
{name: "headerText", global: "MatDoc-headerText", description: locale.css.headerText},
61+
{name: "toolbar", global: "MatDoc-toolbar", description: locale.css.toolbar},
62+
{name: "headerIcon", global: "MatDoc-headerIcon", description: locale.css.headerIcon},
63+
{name: "version", global: "MatDoc-version", description: locale.css.version},
64+
]}
3165
>
3266
<H2>Demos</H2>
3367
<List>

‎src/pages/APIs/DocsMenuAPI/index.js‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,19 @@ import DocsMenu from "@material-docs/core/components/DocsMenu";
1818
export default function DocsMenuAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.DocsMenuAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
24+
name={"DocsMenu"}
2725
localeName={"DocsMenuAPI"}
26+
overrideName={"MatDoc-DocsMenu"}
2827
searchTags={["docs", "menu", "container", "api"]}
29-
name={"DocsMenu"}
3028
importCode={importCode}
29+
properties={[
30+
{name: "dense", type: "boolean", default: "false", description: locale.props.dense},
31+
{name: "children", type: "node", default: "", description: locale.props.children},
32+
]}
33+
enableCss={false}
3134
>
3235
<H2>Demos</H2>
3336
<List>

‎src/pages/APIs/DocsMenuItemAPI/index.js‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,30 @@ import DocsMenuItem from "@material-docs/core/components/DocsMenuItem";
1818
export default function DocsMenuItemAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.DocsMenuItemAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
27-
localeName={"DocsMenuItemAPI"}
28-
searchTags={["docs", "menu", "item", "api", "layout"]}
2924
name={"DocsMenuItem"}
25+
localeName={"DocsMenuItemAPI"}
26+
overrideName={"MatDoc-DocsMenuItem"}
3027
importCode={importCode}
28+
properties={[
29+
{name: "defaultExpanded", type: "boolean", default: "false", description: locale.props.defaultExpanded},
30+
{name: "textPrimary", type: "string", default: "", description: locale.props.textPrimary},
31+
{name: "textSecondary", type: "string", default: "", description: locale.props.textSecondary},
32+
{name: "icon", type: "string", default: "", description: locale.props.icon},
33+
{name: "onClick", type: "function(event: any): void", default: "", description: locale.props.onClick},
34+
{name: "page", type: "string | any", default: "", description: locale.props.page},
35+
{name: "link", type: "string", default: "", description: locale.props.link},
36+
{name: "isCurrent", type: "(function(routeParams, pageRoute, page): boolean) | boolean", default: "false", description: locale.props.isCurrent},
37+
{name: "dense", type: "boolean", default: "false", description: locale.props.dense},
38+
{name: "children", type: "node", default: "", description: locale.props.children},
39+
]}
40+
css={[
41+
{name: "root", global: "MatDoc-root", description: locale.css.root},
42+
{name: "highlighted", global: "MatDoc-highlighted", description: locale.css.highlighted},
43+
{name: "collapse", global: "MatDoc-collapse", description: locale.css.collapse},
44+
]}
3145
>
3246
<H2>Demos</H2>
3347
<List>

‎src/pages/APIs/DocsPageAPI/index.js‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,29 @@ import DocsPage from "@material-docs/core/components/DocsPage";
1818
export default function DocsPageAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.DocsPageAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
27-
localeName={"DocsPageAPI"}
28-
searchTags={["docs", "page", "api"]}
2924
name={"DocsPage"}
25+
localeName={"DocsPageAPI"}
26+
overrideName={"MatDoc-DocsPage"}
3027
importCode={importCode}
28+
properties={[
29+
{name: "name", type: "string", default: "", description: locale.props.name},
30+
{name: "searchTags", type: "string[]", default: "", description: locale.props.searchTags},
31+
{name: "searchLabel", type: "string", default: "", description: locale.props.searchLabel},
32+
{name: "searchDescription", type: "string", default: "", description: locale.props.searchDescription},
33+
{name: "noGenerateAutoSearch", type: "boolean", default: "false", description: locale.props.noGenerateAutoSearch},
34+
{name: "noAutoMenu", type: "boolean", default: "false", description: locale.props.noAutoMenu},
35+
{name: "children", type: "node", default: "", description: locale.props.children},
36+
]}
37+
css={[
38+
{name: "root", global: "MatDoc-root", description: locale.css.root},
39+
{name: "contentItem", global: "MatDoc-contentItem", description: locale.css.contentItem},
40+
{name: "contentItemActive", global: "MatDoc-contentItemActive", description: locale.css.contentItemActive},
41+
{name: "contentLink", global: "MatDoc-contentLink", description: locale.css.contentLink},
42+
{name: "copyright", global: "MatDoc-copyright", description: locale.css.copyright},
43+
]}
3144
>
3245
<H2>Demos</H2>
3346
<List>

‎src/pages/APIs/DocsPagesAPI/index.js‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,17 @@ import DocsPages from "@material-docs/core/components/DocsPages";
1818
export default function DocsPagesAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.DocsPagesAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
27-
localeName={"DocsPagesAPI"}
28-
searchTags={["docs", "pages", "container", "api"]}
2924
name={"DocsPages"}
25+
localeName={"DocsPagesAPI"}
26+
overrideName={"MatDoc-DocsPages"}
3027
importCode={importCode}
28+
properties={[
29+
{name: "children", type: "node", default: "", description: locale.props.children},
30+
]}
31+
enableCss={false}
3132
>
3233
<H2>Demos</H2>
3334
<List>

‎src/pages/APIs/ExpansionCodeAPI/index.js‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,31 @@ import ExpansionCode from "@material-docs/core/components/ExpansionCode";
1818
export default function ExpansionCodeAPI() {
1919
const {lang} = useLang();
2020
const locale = lang.locale.pages.ExpansionCodeAPI;
21-
const localeSpells = lang.locale.common.spells;
22-
const componentAPILocale = lang.locale.common.ComponentAPI;
2321

2422
return (
2523
<ApiPage
26-
lang={lang}
24+
name={"ExpansionCode"}
2725
localeName={"ExpansionCodeAPI"}
26+
overrideName={"MatDoc-ExpansionCode"}
2827
searchTags={["demo", "with", "code", "api"]}
29-
name={"ExpansionCode"}
3028
importCode={importCode}
29+
properties={[
30+
{name: "name", type: "string", default: "", description: locale.props.name},
31+
{name: "noTag", type: "boolean", default: "false", description: locale.props.noTag},
32+
{name: "collapsedHeight", type: "number | string", default: "100px", description: locale.props.collapsedHeight},
33+
{name: "actions", type: "DemoCodeAction[]", default: "", description: locale.props.actions},
34+
{name: "theme", type: "\"light\" | \"dark\" | \"darcula\"", default: "\"light\"", description: locale.props.theme},
35+
{name: "language", type: "string", default: "\"javascript\"", description: locale.props.language},
36+
{name: "children", type: "node", default: "", description: locale.props.children},
37+
]}
38+
css={[
39+
{name: "root", global: "MatDoc-root", description: locale.css.root},
40+
{name: "collapsedCode", global: "MatDoc-collapsedCode", description: locale.css.collapsedCode},
41+
{name: "collapse", global: "MatDoc-collapse", description: locale.css.collapse},
42+
{name: "toolbar", global: "MatDoc-toolbar", description: locale.css.toolbar},
43+
{name: "codeName", global: "MatDoc-codeName", description: locale.css.codeName},
44+
{name: "menuButtonLink", global: "MatDoc-menuButtonLink", description: locale.css.menuButtonLink},
45+
]}
3146
>
3247
<H2>Demos</H2>
3348
<List>

‎src/pages/APIs/H1API/index.js‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,23 @@ import H1 from "@material-docs/core/components/H1";
1717
export default function H1API() {
1818
const {lang} = useLang();
1919
const locale = lang.locale.pages.H1API;
20-
const localeSpells = lang.locale.common.spells;
21-
const componentAPILocale = lang.locale.common.ComponentAPI;
2220

2321
return (
2422
<ApiPage
25-
lang={lang}
26-
localeName={"H1API"}
27-
searchTags={["h1", "header", "tag", "anchor", "api"]}
2823
name={"H1"}
24+
localeName={"H1API"}
25+
overrideName={"MatDoc-H1"}
2926
importCode={importCode}
27+
properties={[
28+
{name: "noDivider", type: "boolean", default: "false", description: locale.props.noDivider},
29+
{name: "noTag", type: "boolean", default: "false", description: locale.props.noTag},
30+
{name: "id", type: "string", default: "", description: locale.props.id},
31+
{name: "children", type: "node", default: "", description: locale.props.children},
32+
]}
33+
css={[
34+
{name: "root", global: "MatDoc-root", description: locale.css.root},
35+
{name: "h1", global: "MatDoc-h1", description: locale.css.h1},
36+
]}
3037
>
3138
<H2>Demos</H2>
3239
<List>

0 commit comments

Comments
 (0)