@sps-woodland/page-title 8.56.11 → 8.56.12

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 (5) hide show
  1. package/README.md +22 -14
  2. package/lib/index.js +5 -5
  3. package/lib/index.umd.cjs +5 -5
  4. package/lib/style.css +1 -1
  5. package/package.json +3 -3
package/README.md CHANGED
@@ -2,27 +2,35 @@
2
2
 
3
3
  SPS Woodland Design System page title component.
4
4
 
5
- > **Heads up — this is a wrapper package.** The component source now lives in
6
- > [`@sps-woodland/core`](../react). This package re-exports from the
7
- > mono-package so existing imports keep working, but new code should prefer the
8
- > mono-package paths.
5
+ > **Deprecated: this package will be removed in Woodland 9.0.** It only re-exports
6
+ > `@sps-woodland/core/page-title` from [`@sps-woodland/core`](https://www.npmjs.com/package/@sps-woodland/core).
7
+ > Components, props, and behavior are identical, so migrating is an import-path change.
9
8
 
10
- ### Preferred imports (core)
9
+ ### Use `@sps-woodland/core` instead
11
10
 
12
11
  ```ts
13
- import { PageTitle, PageSubtitle } from "@sps-woodland/core/page-title";
14
- // or, if you only need the subtitle:
15
- import { PageSubtitle } from "@sps-woodland/core/page-subtitle";
12
+ import {
13
+ PageTitle,
14
+ PageSubtitle,
15
+ HeadingLevelProvider,
16
+ useHeadingLevel,
17
+ } from "@sps-woodland/core/page-title";
16
18
 
17
19
  import "@sps-woodland/core/page-title/style.css";
18
20
  ```
19
21
 
20
- `PageTitle` is barrel-only (the family name and the parent component share a
21
- name). `PageSubtitle` also has its own flat subpath.
22
+ Import every component of a family from the same subpath shown above. Core also has flat
23
+ per-component subpaths, but they are separate module instances, and mixing them with the
24
+ family barrel can silently break parent/child components. Import component stylesheets before
25
+ `@sps-woodland/tokens/lib/vanilla-extract/style.css`.
22
26
 
23
- ### Legacy imports (still supported)
27
+ ### Migrate automatically
24
28
 
25
- ```ts
26
- import { PageTitle, PageSubtitle } from "@sps-woodland/page-title";
27
- import "@sps-woodland/page-title/style.css";
29
+ ```console
30
+ pnpm dlx --package=@sps-woodland/codemods migrate-wrapper-imports src --write
28
31
  ```
32
+
33
+ This rewrites `@sps-woodland/page-title` JavaScript and stylesheet imports to the core paths above.
34
+ Then add `@sps-woodland/core` (8.53 or later) to your dependencies if needed, remove
35
+ `@sps-woodland/page-title`, and reinstall. See the
36
+ [Woodland 8.0 upgrade guide](https://github.com/SPSCommerce/woodland/blob/main/UPGRADE8.0.md#mono-package-consolidation) for details.
package/lib/index.js CHANGED
@@ -9,7 +9,7 @@ var r = { "Page Title": {
9
9
  basic: {
10
10
  label: "Basic",
11
11
  examples: { basic: { react: n`
12
- import { PageTitle } from "@sps-woodland/page-title";
12
+ import { PageTitle } from "@sps-woodland/core/page-title";
13
13
 
14
14
  function Component() {
15
15
  return (
@@ -27,7 +27,7 @@ var r = { "Page Title": {
27
27
  headingLevel: {
28
28
  description: "PageTitle renders an h1 by default. Use the as prop to match the heading level to the position of the title in the page outline, or use div for a title that is not a heading.",
29
29
  react: n`
30
- import { PageTitle } from "@sps-woodland/page-title";
30
+ import { PageTitle } from "@sps-woodland/core/page-title";
31
31
 
32
32
  function Component() {
33
33
  return <PageTitle as="h2">Cabela's Purchase Order #123456789012</PageTitle>;
@@ -37,7 +37,7 @@ var r = { "Page Title": {
37
37
  provider: {
38
38
  description: "Wrap a region in HeadingLevelProvider to set the heading level for every PageTitle inside it that has no as prop. An as prop on a PageTitle overrides the provider.",
39
39
  react: n`
40
- import { PageTitle, HeadingLevelProvider } from "@sps-woodland/page-title";
40
+ import { PageTitle, HeadingLevelProvider } from "@sps-woodland/core/page-title";
41
41
 
42
42
  function Component() {
43
43
  return (
@@ -55,7 +55,7 @@ var r = { "Page Title": {
55
55
  div: {
56
56
  description: "Use as=\"div\" for a title that is not a heading. The title renders without a heading element.",
57
57
  react: n`
58
- import { PageTitle } from "@sps-woodland/page-title";
58
+ import { PageTitle } from "@sps-woodland/core/page-title";
59
59
 
60
60
  function Component() {
61
61
  return <PageTitle as="div">Cabela's Purchase Order #123456789012</PageTitle>;
@@ -67,7 +67,7 @@ var r = { "Page Title": {
67
67
  subtitle: {
68
68
  label: "Subtitle",
69
69
  examples: { withSubtitle: { react: n`
70
- import { PageTitle, PageSubtitle } from "@sps-woodland/page-title";
70
+ import { PageTitle, PageSubtitle } from "@sps-woodland/core/page-title";
71
71
  import { Icon } from "@sps-woodland/core";
72
72
 
73
73
  function Component() {
package/lib/index.umd.cjs CHANGED
@@ -1,5 +1,5 @@
1
1
  (function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports,require("@sps-woodland/core/page-title"),require("@spscommerce/utils")):typeof define==`function`&&define.amd?define([`exports`,`@sps-woodland/core/page-title`,`@spscommerce/utils`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.PageTitle={},e.spsWoodlandCorePageTitle,e.spscommerceUtils))})(this,function(e,t,n){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`}),e.MANIFEST={"Page Title":{components:[t.PageTitle,t.PageSubtitle],examples:{basic:{label:`Basic`,examples:{basic:{react:n.code`
2
- import { PageTitle } from "@sps-woodland/page-title";
2
+ import { PageTitle } from "@sps-woodland/core/page-title";
3
3
 
4
4
  function Component() {
5
5
  return (
@@ -10,13 +10,13 @@
10
10
  );
11
11
  }
12
12
  `}}},element:{label:`Heading Level`,examples:{headingLevel:{description:`PageTitle renders an h1 by default. Use the as prop to match the heading level to the position of the title in the page outline, or use div for a title that is not a heading.`,react:n.code`
13
- import { PageTitle } from "@sps-woodland/page-title";
13
+ import { PageTitle } from "@sps-woodland/core/page-title";
14
14
 
15
15
  function Component() {
16
16
  return <PageTitle as="h2">Cabela's Purchase Order #123456789012</PageTitle>;
17
17
  }
18
18
  `},provider:{description:`Wrap a region in HeadingLevelProvider to set the heading level for every PageTitle inside it that has no as prop. An as prop on a PageTitle overrides the provider.`,react:n.code`
19
- import { PageTitle, HeadingLevelProvider } from "@sps-woodland/page-title";
19
+ import { PageTitle, HeadingLevelProvider } from "@sps-woodland/core/page-title";
20
20
 
21
21
  function Component() {
22
22
  return (
@@ -30,13 +30,13 @@
30
30
  );
31
31
  }
32
32
  `},div:{description:`Use as="div" for a title that is not a heading. The title renders without a heading element.`,react:n.code`
33
- import { PageTitle } from "@sps-woodland/page-title";
33
+ import { PageTitle } from "@sps-woodland/core/page-title";
34
34
 
35
35
  function Component() {
36
36
  return <PageTitle as="div">Cabela's Purchase Order #123456789012</PageTitle>;
37
37
  }
38
38
  `}}},subtitle:{label:`Subtitle`,examples:{withSubtitle:{react:n.code`
39
- import { PageTitle, PageSubtitle } from "@sps-woodland/page-title";
39
+ import { PageTitle, PageSubtitle } from "@sps-woodland/core/page-title";
40
40
  import { Icon } from "@sps-woodland/core";
41
41
 
42
42
  function Component() {
package/lib/style.css CHANGED
@@ -1,2 +1,2 @@
1
- .pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_14qi3ku0{color:#4b5356;margin-top:.25rem;font-size:1.125rem;line-height:1.125rem}.pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_14qi3ku1{margin-top:.25rem;margin-left:.25rem;margin-right:.25rem;font-size:.75rem;line-height:1.125rem}.pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_6nwwl00{flex-direction:row;display:flex}.pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_6nwwl01{color:#1f282c;flex-direction:column;font-size:1.5rem;line-height:1.5rem;display:flex}.pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_6nwwl02{align-self:flex-start;margin-top:.1875rem;margin-right:.25rem;font-size:1.125rem;line-height:1.5rem}.pkg_sps-woodland_core__family_page-title__version_8_56_11__hash_6nwwl03{color:inherit;font-size:inherit;font-weight:inherit;line-height:inherit;margin:0}
1
+ .pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_14qi3ku0{color:#4b5356;margin-top:.25rem;font-size:1.125rem;line-height:1.125rem}.pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_14qi3ku1{margin-top:.25rem;margin-left:.25rem;margin-right:.25rem;font-size:.75rem;line-height:1.125rem}.pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_6nwwl00{flex-direction:row;display:flex}.pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_6nwwl01{color:#1f282c;flex-direction:column;font-size:1.5rem;line-height:1.5rem;display:flex}.pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_6nwwl02{align-self:flex-start;margin-top:.1875rem;margin-right:.25rem;font-size:1.125rem;line-height:1.5rem}.pkg_sps-woodland_core__family_page-title__version_8_56_12__hash_6nwwl03{color:inherit;font-size:inherit;font-weight:inherit;line-height:inherit;margin:0}
2
2
  /*$vite$:1*/
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sps-woodland/page-title",
3
3
  "description": "SPS Woodland Design System page title component",
4
- "version": "8.56.11",
4
+ "version": "8.56.12",
5
5
  "author": "SPS Commerce",
6
6
  "license": "UNLICENSED",
7
7
  "repository": "https://github.com/SPSCommerce/woodland/tree/main/packages/@sps-woodland/page-title",
@@ -30,13 +30,13 @@
30
30
  "@spscommerce/utils": "^7.0.0 || ^8.0.0 || ^9.0.0",
31
31
  "react": "^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
32
32
  "react-dom": "^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
33
- "@sps-woodland/core": "8.56.11"
33
+ "@sps-woodland/core": "8.56.12"
34
34
  },
35
35
  "devDependencies": {
36
36
  "@spscommerce/utils": "9.3.3",
37
37
  "react": "16.14.0",
38
38
  "react-dom": "16.14.0",
39
- "@sps-woodland/core": "8.56.11"
39
+ "@sps-woodland/core": "8.56.12"
40
40
  },
41
41
  "scripts": {
42
42
  "build": "pnpm run build:js && pnpm run build:types && pnpm run build:css",