@docusaurus/theme-classic 0.0.0-4716 → 0.0.0-4721

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 (3) hide show
  1. package/lib-next/theme/DocBreadcrumbs/index.js +25 -9
  2. package/package.json +13 -13
  3. package/src/theme/DocBreadcrumbs/index.tsx +26 -8
package/lib-next/theme/DocBreadcrumbs/index.js CHANGED
@@ -18,21 +18,27 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; // TODO move to design system f
18
18
  function BreadcrumbsItemLink({children, href}) {
19
19
  const className = clsx('breadcrumbs__link', styles.breadcrumbsItemLink);
20
20
  return href ? (
21
- <Link className={className} href={href}>
22
- {children}
21
+ <Link className={className} href={href} itemProp="item">
22
+ <span itemProp="name">{children}</span>
23
23
  </Link>
24
24
  ) : (
25
- <span className={className}>{children}</span>
25
+ <span className={className} itemProp="item name">
26
+ {children}
27
+ </span>
26
28
  );
27
29
  } // TODO move to design system folder
28
30
 
29
- function BreadcrumbsItem({children, active}) {
31
+ function BreadcrumbsItem({children, active, index}) {
30
32
  return (
31
33
  <li
34
+ itemScope
35
+ itemProp="itemListElement"
36
+ itemType="https://schema.org/ListItem"
32
37
  className={clsx('breadcrumbs__item', {
33
38
  'breadcrumbs__item--active': active,
34
39
  })}>
35
40
  {children}
41
+ <meta itemProp="position" content={String(index + 1)} />
36
42
  </li>
37
43
  );
38
44
  }
@@ -40,9 +46,13 @@ function BreadcrumbsItem({children, active}) {
40
46
  function HomeBreadcrumbItem() {
41
47
  const homeHref = useBaseUrl('/');
42
48
  return (
43
- <BreadcrumbsItem>
44
- <BreadcrumbsItemLink href={homeHref}>🏠</BreadcrumbsItemLink>
45
- </BreadcrumbsItem>
49
+ <li className="breadcrumbs__item">
50
+ <Link
51
+ className={clsx('breadcrumbs__link', styles.breadcrumbsItemLink)}
52
+ href={homeHref}>
53
+ 🏠
54
+ </Link>
55
+ </li>
46
56
  );
47
57
  }
48
58
 
@@ -61,10 +71,16 @@ export default function DocBreadcrumbs() {
61
71
  styles.breadcrumbsContainer,
62
72
  )}
63
73
  aria-label="breadcrumbs">
64
- <ul className="breadcrumbs">
74
+ <ul
75
+ className="breadcrumbs"
76
+ itemScope
77
+ itemType="https://schema.org/BreadcrumbList">
65
78
  {homePageRoute && <HomeBreadcrumbItem />}
66
79
  {breadcrumbs.map((item, idx) => (
67
- <BreadcrumbsItem key={idx} active={idx === breadcrumbs.length - 1}>
80
+ <BreadcrumbsItem
81
+ key={idx}
82
+ active={idx === breadcrumbs.length - 1}
83
+ index={idx}>
68
84
  <BreadcrumbsItemLink href={item.href}>
69
85
  {item.label}
70
86
  </BreadcrumbsItemLink>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/theme-classic",
3
- "version": "0.0.0-4716",
3
+ "version": "0.0.0-4721",
4
4
  "description": "Classic theme for Docusaurus",
5
5
  "main": "lib/index.js",
6
6
  "types": "src/theme-classic.d.ts",
@@ -21,15 +21,15 @@
21
21
  "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
22
22
  },
23
23
  "dependencies": {
24
- "@docusaurus/core": "0.0.0-4716",
25
- "@docusaurus/plugin-content-blog": "0.0.0-4716",
26
- "@docusaurus/plugin-content-docs": "0.0.0-4716",
27
- "@docusaurus/plugin-content-pages": "0.0.0-4716",
28
- "@docusaurus/theme-common": "0.0.0-4716",
29
- "@docusaurus/theme-translations": "0.0.0-4716",
30
- "@docusaurus/utils": "0.0.0-4716",
31
- "@docusaurus/utils-common": "0.0.0-4716",
32
- "@docusaurus/utils-validation": "0.0.0-4716",
24
+ "@docusaurus/core": "0.0.0-4721",
25
+ "@docusaurus/plugin-content-blog": "0.0.0-4721",
26
+ "@docusaurus/plugin-content-docs": "0.0.0-4721",
27
+ "@docusaurus/plugin-content-pages": "0.0.0-4721",
28
+ "@docusaurus/theme-common": "0.0.0-4721",
29
+ "@docusaurus/theme-translations": "0.0.0-4721",
30
+ "@docusaurus/utils": "0.0.0-4721",
31
+ "@docusaurus/utils-common": "0.0.0-4721",
32
+ "@docusaurus/utils-validation": "0.0.0-4721",
33
33
  "@mdx-js/react": "^1.6.22",
34
34
  "clsx": "^1.1.1",
35
35
  "copy-text-to-clipboard": "^3.0.1",
@@ -42,8 +42,8 @@
42
42
  "rtlcss": "^3.3.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@docusaurus/module-type-aliases": "0.0.0-4716",
46
- "@docusaurus/types": "0.0.0-4716",
45
+ "@docusaurus/module-type-aliases": "0.0.0-4721",
46
+ "@docusaurus/types": "0.0.0-4721",
47
47
  "@types/mdx-js__react": "^1.5.5",
48
48
  "@types/prismjs": "^1.26.0",
49
49
  "@types/rtlcss": "^3.1.2",
@@ -59,5 +59,5 @@
59
59
  "engines": {
60
60
  "node": ">=14"
61
61
  },
62
- "gitHead": "bb0c99cc87181c3285556e88233fcbb1695ae1a7"
62
+ "gitHead": "e01ee5ebec6b6fd7e5084cc67014a555329cc336"
63
63
  }
package/src/theme/DocBreadcrumbs/index.tsx CHANGED
@@ -26,11 +26,13 @@ function BreadcrumbsItemLink({
26
26
  }): JSX.Element {
27
27
  const className = clsx('breadcrumbs__link', styles.breadcrumbsItemLink);
28
28
  return href ? (
29
- <Link className={className} href={href}>
30
- {children}
29
+ <Link className={className} href={href} itemProp="item">
30
+ <span itemProp="name">{children}</span>
31
31
  </Link>
32
32
  ) : (
33
- <span className={className}>{children}</span>
33
+ <span className={className} itemProp="item name">
34
+ {children}
35
+ </span>
34
36
  );
35
37
  }
36
38
 
@@ -38,16 +40,22 @@ function BreadcrumbsItemLink({
38
40
  function BreadcrumbsItem({
39
41
  children,
40
42
  active,
43
+ index,
41
44
  }: {
42
45
  children: ReactNode;
43
46
  active?: boolean;
47
+ index: number;
44
48
  }): JSX.Element {
45
49
  return (
46
50
  <li
51
+ itemScope
52
+ itemProp="itemListElement"
53
+ itemType="https://schema.org/ListItem"
47
54
  className={clsx('breadcrumbs__item', {
48
55
  'breadcrumbs__item--active': active,
49
56
  })}>
50
57
  {children}
58
+ <meta itemProp="position" content={String(index + 1)} />
51
59
  </li>
52
60
  );
53
61
  }
@@ -55,9 +63,13 @@ function BreadcrumbsItem({
55
63
  function HomeBreadcrumbItem() {
56
64
  const homeHref = useBaseUrl('/');
57
65
  return (
58
- <BreadcrumbsItem>
59
- <BreadcrumbsItemLink href={homeHref}>🏠</BreadcrumbsItemLink>
60
- </BreadcrumbsItem>
66
+ <li className="breadcrumbs__item">
67
+ <Link
68
+ className={clsx('breadcrumbs__link', styles.breadcrumbsItemLink)}
69
+ href={homeHref}>
70
+ 🏠
71
+ </Link>
72
+ </li>
61
73
  );
62
74
  }
63
75
 
@@ -76,10 +88,16 @@ export default function DocBreadcrumbs(): JSX.Element | null {
76
88
  styles.breadcrumbsContainer,
77
89
  )}
78
90
  aria-label="breadcrumbs">
79
- <ul className="breadcrumbs">
91
+ <ul
92
+ className="breadcrumbs"
93
+ itemScope
94
+ itemType="https://schema.org/BreadcrumbList">
80
95
  {homePageRoute && <HomeBreadcrumbItem />}
81
96
  {breadcrumbs.map((item, idx) => (
82
- <BreadcrumbsItem key={idx} active={idx === breadcrumbs.length - 1}>
97
+ <BreadcrumbsItem
98
+ key={idx}
99
+ active={idx === breadcrumbs.length - 1}
100
+ index={idx}>
83
101
  <BreadcrumbsItemLink href={item.href}>
84
102
  {item.label}
85
103
  </BreadcrumbsItemLink>