@docusaurus/theme-common 3.7.0-canary-6237 → 3.7.0-canary-6239

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/lib/utils/ThemeClassNames.d.ts +21 -1
  2. package/lib/utils/ThemeClassNames.d.ts.map +1 -1
  3. package/lib/utils/ThemeClassNames.js +21 -2
  4. package/lib/utils/ThemeClassNames.js.map +1 -1
  5. package/package.json +8 -8
  6. package/src/utils/ThemeClassNames.ts +25 -2
package/lib/utils/ThemeClassNames.d.ts CHANGED
@@ -37,7 +37,27 @@ export declare const ThemeClassNames: {
37
37
  readonly draftBanner: "theme-draft-banner";
38
38
  readonly admonitionType: (type: string) => string;
39
39
  };
40
- readonly layout: {};
40
+ readonly announcementBar: {
41
+ readonly container: "theme-announcement-bar";
42
+ };
43
+ readonly layout: {
44
+ readonly navbar: {
45
+ readonly container: "theme-layout-navbar";
46
+ readonly containerLeft: "theme-layout-navbar-left";
47
+ readonly containerRight: "theme-layout-navbar-right";
48
+ readonly mobileSidebar: {
49
+ readonly container: "theme-layout-navbar-sidebar";
50
+ readonly panel: "theme-layout-navbar-sidebar-panel";
51
+ };
52
+ };
53
+ readonly main: {
54
+ readonly container: "theme-layout-main";
55
+ };
56
+ readonly footer: {
57
+ readonly container: "theme-layout-footer";
58
+ readonly column: "theme-layout-footer-column";
59
+ };
60
+ };
41
61
  /**
42
62
  * Follows the naming convention "theme-{blog,doc,version,page}?-<suffix>"
43
63
  */
package/lib/utils/ThemeClassNames.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAiCD,MAAM;;;IAM/B;;OAEG;;;;;;;;;;;;;;;sDAeoC,MAAM;kDAEV,MAAM;;;;;;;;;CAYjC,CAAC"}
1
+ {"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAoCD,MAAM;;;;;;;;;;;;;;;;;;;;;;;IA0B/B;;OAEG;;;;;;;;;;;;;;;sDAeoC,MAAM;kDAEV,MAAM;;;;;;;;;CAYjC,CAAC"}
package/lib/utils/ThemeClassNames.js CHANGED
@@ -23,8 +23,9 @@ export const ThemeClassNames = {
23
23
  docsTagDocListPage: 'docs-tags-doc-list-page',
24
24
  mdxPage: 'mdx-page',
25
25
  },
26
+ // TODO Docusaurus v4: remove old classes?
26
27
  wrapper: {
27
- main: 'main-wrapper',
28
+ main: 'main-wrapper', // replaced by theme-layout-main
28
29
  // TODO these wrapper class names are now quite useless
29
30
  // TODO do breaking change later in 3.0
30
31
  // we already add plugin name/id class on <html>: that's enough
@@ -42,8 +43,26 @@ export const ThemeClassNames = {
42
43
  draftBanner: 'theme-draft-banner',
43
44
  admonitionType: (type) => `theme-admonition-${type}`,
44
45
  },
46
+ announcementBar: {
47
+ container: 'theme-announcement-bar',
48
+ },
45
49
  layout: {
46
- // TODO add other stable classNames here
50
+ navbar: {
51
+ container: 'theme-layout-navbar',
52
+ containerLeft: 'theme-layout-navbar-left',
53
+ containerRight: 'theme-layout-navbar-right',
54
+ mobileSidebar: {
55
+ container: 'theme-layout-navbar-sidebar',
56
+ panel: 'theme-layout-navbar-sidebar-panel',
57
+ },
58
+ },
59
+ main: {
60
+ container: 'theme-layout-main',
61
+ },
62
+ footer: {
63
+ container: 'theme-layout-footer',
64
+ column: 'theme-layout-footer-column',
65
+ },
47
66
  },
48
67
  /**
49
68
  * Follows the naming convention "theme-{blog,doc,version,page}?-<suffix>"
package/lib/utils/ThemeClassNames.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,+EAA+E;AAC/E,aAAa;AAEb;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAC/C,mBAAmB,EAAE,wBAAwB;QAC7C,oBAAoB,EAAE,yBAAyB;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,cAAc;QACpB,uDAAuD;QACvD,uCAAuC;QACvC,+DAA+D;QAC/D,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IACD,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;QAC7B,UAAU,EAAE,kBAAkB;QAC9B,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QAEjC,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,oBAAoB,IAAI,EAAE;KAC7D;IACD,MAAM,EAAE;IACN,wCAAwC;KACzC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,mBAAmB,EAAE,6BAA6B;QAClD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;QACJ,wCAAwC;QACxC,iBAAiB,EAAE,4BAA4B;QAC/C,qBAAqB,EAAE,iCAAiC;KACzD;IACD,KAAK,EAAE;QACL,qBAAqB,EAAE,kCAAkC;KAC1D;CACO,CAAC"}
1
+ {"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,+EAA+E;AAC/E,aAAa;AAEb;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAC/C,mBAAmB,EAAE,wBAAwB;QAC7C,oBAAoB,EAAE,yBAAyB;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IAED,0CAA0C;IAC1C,OAAO,EAAE;QACP,IAAI,EAAE,cAAc,EAAE,gCAAgC;QACtD,uDAAuD;QACvD,uCAAuC;QACvC,+DAA+D;QAC/D,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IAED,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;QAC7B,UAAU,EAAE,kBAAkB;QAC9B,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QAEjC,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,oBAAoB,IAAI,EAAE;KAC7D;IAED,eAAe,EAAE;QACf,SAAS,EAAE,wBAAwB;KACpC;IAED,MAAM,EAAE;QACN,MAAM,EAAE;YACN,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,0BAA0B;YACzC,cAAc,EAAE,2BAA2B;YAC3C,aAAa,EAAE;gBACb,SAAS,EAAE,6BAA6B;gBACxC,KAAK,EAAE,mCAAmC;aAC3C;SACF;QACD,IAAI,EAAE;YACJ,SAAS,EAAE,mBAAmB;SAC/B;QACD,MAAM,EAAE;YACN,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE,4BAA4B;SACrC;KACF;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,mBAAmB,EAAE,6BAA6B;QAClD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;QACJ,wCAAwC;QACxC,iBAAiB,EAAE,4BAA4B;QAC/C,qBAAqB,EAAE,iCAAiC;KACzD;IACD,KAAK,EAAE;QACL,qBAAqB,EAAE,kCAAkC;KAC1D;CACO,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/theme-common",
3
- "version": "3.7.0-canary-6237",
3
+ "version": "3.7.0-canary-6239",
4
4
  "description": "Common code for Docusaurus themes.",
5
5
  "main": "./lib/index.js",
6
6
  "types": "./lib/index.d.ts",
@@ -30,10 +30,10 @@
30
30
  },
31
31
  "license": "MIT",
32
32
  "dependencies": {
33
- "@docusaurus/mdx-loader": "3.7.0-canary-6237",
34
- "@docusaurus/module-type-aliases": "3.7.0-canary-6237",
35
- "@docusaurus/utils": "3.7.0-canary-6237",
36
- "@docusaurus/utils-common": "3.7.0-canary-6237",
33
+ "@docusaurus/mdx-loader": "3.7.0-canary-6239",
34
+ "@docusaurus/module-type-aliases": "3.7.0-canary-6239",
35
+ "@docusaurus/utils": "3.7.0-canary-6239",
36
+ "@docusaurus/utils-common": "3.7.0-canary-6239",
37
37
  "@types/history": "^4.7.11",
38
38
  "@types/react": "*",
39
39
  "@types/react-router-config": "*",
@@ -44,8 +44,8 @@
44
44
  "utility-types": "^3.10.0"
45
45
  },
46
46
  "devDependencies": {
47
- "@docusaurus/core": "3.7.0-canary-6237",
48
- "@docusaurus/types": "3.7.0-canary-6237",
47
+ "@docusaurus/core": "3.7.0-canary-6239",
48
+ "@docusaurus/types": "3.7.0-canary-6239",
49
49
  "fs-extra": "^11.1.1",
50
50
  "lodash": "^4.17.21"
51
51
  },
@@ -57,5 +57,5 @@
57
57
  "engines": {
58
58
  "node": ">=18.0"
59
59
  },
60
- "gitHead": "fda080b1f00817057cfed649f1542f5d71dd85a3"
60
+ "gitHead": "334f8b2289b44cb348f1325f61c9f94e46b41602"
61
61
  }
package/src/utils/ThemeClassNames.ts CHANGED
@@ -27,8 +27,10 @@ export const ThemeClassNames = {
27
27
 
28
28
  mdxPage: 'mdx-page',
29
29
  },
30
+
31
+ // TODO Docusaurus v4: remove old classes?
30
32
  wrapper: {
31
- main: 'main-wrapper',
33
+ main: 'main-wrapper', // replaced by theme-layout-main
32
34
  // TODO these wrapper class names are now quite useless
33
35
  // TODO do breaking change later in 3.0
34
36
  // we already add plugin name/id class on <html>: that's enough
@@ -36,6 +38,7 @@ export const ThemeClassNames = {
36
38
  docsPages: 'docs-wrapper',
37
39
  mdxPages: 'mdx-wrapper',
38
40
  },
41
+
39
42
  common: {
40
43
  editThisPage: 'theme-edit-this-page',
41
44
  lastUpdated: 'theme-last-updated',
@@ -47,8 +50,28 @@ export const ThemeClassNames = {
47
50
 
48
51
  admonitionType: (type: string) => `theme-admonition-${type}`,
49
52
  },
53
+
54
+ announcementBar: {
55
+ container: 'theme-announcement-bar',
56
+ },
57
+
50
58
  layout: {
51
- // TODO add other stable classNames here
59
+ navbar: {
60
+ container: 'theme-layout-navbar',
61
+ containerLeft: 'theme-layout-navbar-left',
62
+ containerRight: 'theme-layout-navbar-right',
63
+ mobileSidebar: {
64
+ container: 'theme-layout-navbar-sidebar',
65
+ panel: 'theme-layout-navbar-sidebar-panel',
66
+ },
67
+ },
68
+ main: {
69
+ container: 'theme-layout-main',
70
+ },
71
+ footer: {
72
+ container: 'theme-layout-footer',
73
+ column: 'theme-layout-footer-column',
74
+ },
52
75
  },
53
76
 
54
77
  /**