@entur/typography 3.0.7 → 3.2.0
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.
- package/README.md +9 -38
- package/dist/beta/cjs/components/Heading.cjs +39 -29
- package/dist/beta/cjs/components/Heading.cjs.map +1 -1
- package/dist/beta/cjs/components/Label.cjs +22 -0
- package/dist/beta/cjs/components/Label.cjs.map +1 -0
- package/dist/beta/cjs/components/Link.cjs +18 -33
- package/dist/beta/cjs/components/Link.cjs.map +1 -1
- package/dist/beta/cjs/components/ListItem.cjs +34 -25
- package/dist/beta/cjs/components/ListItem.cjs.map +1 -1
- package/dist/beta/cjs/components/NumberedList.cjs +36 -24
- package/dist/beta/cjs/components/NumberedList.cjs.map +1 -1
- package/dist/beta/cjs/components/Text.cjs +40 -28
- package/dist/beta/cjs/components/Text.cjs.map +1 -1
- package/dist/beta/cjs/components/TextContainer.cjs +26 -0
- package/dist/beta/cjs/components/TextContainer.cjs.map +1 -0
- package/dist/beta/cjs/components/UnorderedList.cjs +31 -21
- package/dist/beta/cjs/components/UnorderedList.cjs.map +1 -1
- package/dist/beta/cjs/index.cjs +8 -3
- package/dist/beta/cjs/index.cjs.map +1 -1
- package/dist/beta/cjs/utils/utils.cjs +73 -41
- package/dist/beta/cjs/utils/utils.cjs.map +1 -1
- package/dist/beta/cjs/utils/warnAboutGlobalStyles.cjs +113 -0
- package/dist/beta/cjs/utils/warnAboutGlobalStyles.cjs.map +1 -0
- package/dist/beta/esm/components/Heading.mjs +40 -30
- package/dist/beta/esm/components/Heading.mjs.map +1 -1
- package/dist/beta/esm/components/Label.mjs +22 -0
- package/dist/beta/esm/components/Label.mjs.map +1 -0
- package/dist/beta/esm/components/Link.mjs +20 -35
- package/dist/beta/esm/components/Link.mjs.map +1 -1
- package/dist/beta/esm/components/ListItem.mjs +35 -26
- package/dist/beta/esm/components/ListItem.mjs.map +1 -1
- package/dist/beta/esm/components/NumberedList.mjs +37 -25
- package/dist/beta/esm/components/NumberedList.mjs.map +1 -1
- package/dist/beta/esm/components/Text.mjs +41 -29
- package/dist/beta/esm/components/Text.mjs.map +1 -1
- package/dist/beta/esm/components/TextContainer.mjs +26 -0
- package/dist/beta/esm/components/TextContainer.mjs.map +1 -0
- package/dist/beta/esm/components/UnorderedList.mjs +32 -22
- package/dist/beta/esm/components/UnorderedList.mjs.map +1 -1
- package/dist/beta/esm/index.mjs +8 -3
- package/dist/beta/esm/index.mjs.map +1 -1
- package/dist/beta/esm/utils/utils.mjs +73 -41
- package/dist/beta/esm/utils/utils.mjs.map +1 -1
- package/dist/beta/esm/utils/warnAboutGlobalStyles.mjs +113 -0
- package/dist/beta/esm/utils/warnAboutGlobalStyles.mjs.map +1 -0
- package/dist/beta/styles/index.css +878 -609
- package/dist/beta/types/components/Heading.d.ts +27 -11
- package/dist/beta/types/components/Label.d.ts +22 -0
- package/dist/beta/types/components/Link.d.ts +11 -9
- package/dist/beta/types/components/ListItem.d.ts +13 -7
- package/dist/beta/types/components/NumberedList.d.ts +17 -7
- package/dist/beta/types/components/Text.d.ts +33 -13
- package/dist/beta/types/components/TextContainer.d.ts +25 -0
- package/dist/beta/types/components/UnorderedList.d.ts +13 -7
- package/dist/beta/types/index.d.ts +11 -2
- package/dist/beta/types/tests/styles.test.d.ts +1 -0
- package/dist/beta/types/tests/warnAboutGlobalStyles.test.d.ts +1 -0
- package/dist/beta/types/types.d.ts +16 -5
- package/dist/beta/types/utils/utils.d.ts +15 -4
- package/dist/beta/types/utils/warnAboutGlobalStyles.d.ts +4 -0
- package/dist/styles.css +13 -5
- package/dist/styles.no-base-tokens.css +822 -0
- package/package.json +8 -12
- package/dist/beta/cjs/components/Blockquote.cjs +0 -29
- package/dist/beta/cjs/components/Blockquote.cjs.map +0 -1
- package/dist/beta/esm/components/Blockquote.mjs +0 -29
- package/dist/beta/esm/components/Blockquote.mjs.map +0 -1
- package/dist/beta/types/components/Blockquote.d.ts +0 -12
- package/scripts/migrate-typography.mjs +0 -1462
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
const GUIDE_URL = "https://github.com/entur/design-system/blob/main/skills/entur-web-development/references/css-layers.md#the-beta-typography-and-your-global-css";
|
|
2
|
+
const COMPARED_PROPERTIES = [
|
|
3
|
+
"font-size",
|
|
4
|
+
"line-height",
|
|
5
|
+
"font-weight",
|
|
6
|
+
"font-family",
|
|
7
|
+
"color",
|
|
8
|
+
"letter-spacing",
|
|
9
|
+
"margin-top",
|
|
10
|
+
"margin-bottom",
|
|
11
|
+
"padding-left",
|
|
12
|
+
"text-decoration-line",
|
|
13
|
+
"background-color",
|
|
14
|
+
"list-style-type"
|
|
15
|
+
];
|
|
16
|
+
const PROBES = [
|
|
17
|
+
...["h1", "h2", "h3", "h4", "h5", "h6"].map((element) => ({
|
|
18
|
+
element,
|
|
19
|
+
twin: "div",
|
|
20
|
+
className: "eds-heading eds-heading--title-2",
|
|
21
|
+
component: "Heading"
|
|
22
|
+
})),
|
|
23
|
+
{
|
|
24
|
+
element: "p",
|
|
25
|
+
twin: "div",
|
|
26
|
+
className: "eds-text eds-text--paragraph",
|
|
27
|
+
component: "Text"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
element: "a",
|
|
31
|
+
twin: "span",
|
|
32
|
+
className: "eds-text--link",
|
|
33
|
+
component: "Link"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
element: "ul",
|
|
37
|
+
twin: "div",
|
|
38
|
+
className: "eds-text eds-text--unordered-list",
|
|
39
|
+
component: "UnorderedList"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
element: "code",
|
|
43
|
+
twin: "span",
|
|
44
|
+
className: "eds-text eds-text--code",
|
|
45
|
+
component: 'Text variant="code"'
|
|
46
|
+
}
|
|
47
|
+
];
|
|
48
|
+
function findGlobalStyleConflicts() {
|
|
49
|
+
const host = document.createElement("div");
|
|
50
|
+
host.setAttribute("aria-hidden", "true");
|
|
51
|
+
host.style.cssText = "position:absolute;top:0;left:-10000px;width:600px;visibility:hidden;pointer-events:none";
|
|
52
|
+
const container = document.createElement("div");
|
|
53
|
+
container.className = "eds-text-container";
|
|
54
|
+
container.innerHTML = '<p class="eds-text eds-text--paragraph">x</p><p class="eds-text eds-text--paragraph">x</p>';
|
|
55
|
+
host.append(container);
|
|
56
|
+
const pairs = PROBES.map((probe) => {
|
|
57
|
+
const [element, twin] = [probe.element, probe.twin].map((tag) => {
|
|
58
|
+
const node = document.createElement(tag);
|
|
59
|
+
node.className = probe.className;
|
|
60
|
+
node.textContent = "x";
|
|
61
|
+
host.append(node);
|
|
62
|
+
return node;
|
|
63
|
+
});
|
|
64
|
+
return { probe, element, twin };
|
|
65
|
+
});
|
|
66
|
+
document.body.append(host);
|
|
67
|
+
const conflicts = [];
|
|
68
|
+
if (window.getComputedStyle(container).display === "flow-root") {
|
|
69
|
+
if (window.getComputedStyle(container.lastElementChild).marginTop === "0px") {
|
|
70
|
+
conflicts.push(
|
|
71
|
+
"TextContainer has no space between texts. Often a reset like `* { margin: 0 }`."
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
pairs.forEach(({ probe, element, twin }) => {
|
|
75
|
+
const elementStyle = window.getComputedStyle(element);
|
|
76
|
+
const twinStyle = window.getComputedStyle(twin);
|
|
77
|
+
const changed = COMPARED_PROPERTIES.filter(
|
|
78
|
+
(property) => elementStyle.getPropertyValue(property) !== twinStyle.getPropertyValue(property)
|
|
79
|
+
);
|
|
80
|
+
if (changed.length > 0) {
|
|
81
|
+
conflicts.push(
|
|
82
|
+
`\`${probe.element} { ${changed.join("; ")} }\` overrides ${probe.component}.`
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
host.remove();
|
|
88
|
+
return conflicts;
|
|
89
|
+
}
|
|
90
|
+
let checkTimeoutId;
|
|
91
|
+
function warnAboutGlobalStyles() {
|
|
92
|
+
if (process.env.NODE_ENV === "production") return;
|
|
93
|
+
if (typeof window === "undefined" || typeof process !== "undefined" && process.env.TEST === "true" || checkTimeoutId !== void 0) {
|
|
94
|
+
return;
|
|
95
|
+
}
|
|
96
|
+
checkTimeoutId = window.setTimeout(() => {
|
|
97
|
+
const conflicts = findGlobalStyleConflicts();
|
|
98
|
+
if (conflicts.length === 0) return;
|
|
99
|
+
console.warn(
|
|
100
|
+
`@entur/typography: global CSS in your app overrides the typography components.
|
|
101
|
+
|
|
102
|
+
${conflicts.map((conflict) => ` - ${conflict}`).join("\n")}
|
|
103
|
+
|
|
104
|
+
CSS outside a cascade layer always wins over the typography, which sits in layers. Move resets into \`@layer core.reset\` and element styles into \`@layer core.base\`, with the layer order declared first:
|
|
105
|
+
${GUIDE_URL}`
|
|
106
|
+
);
|
|
107
|
+
}, 1e3);
|
|
108
|
+
}
|
|
109
|
+
export {
|
|
110
|
+
findGlobalStyleConflicts,
|
|
111
|
+
warnAboutGlobalStyles
|
|
112
|
+
};
|
|
113
|
+
//# sourceMappingURL=warnAboutGlobalStyles.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"warnAboutGlobalStyles.mjs","sources":["../../../../src/beta/utils/warnAboutGlobalStyles.ts"],"sourcesContent":["const GUIDE_URL =\n 'https://github.com/entur/design-system/blob/main/skills/entur-web-development/references/css-layers.md#the-beta-typography-and-your-global-css';\n\nconst COMPARED_PROPERTIES = [\n 'font-size',\n 'line-height',\n 'font-weight',\n 'font-family',\n 'color',\n 'letter-spacing',\n 'margin-top',\n 'margin-bottom',\n 'padding-left',\n 'text-decoration-line',\n 'background-color',\n 'list-style-type',\n];\n\n// Each element is paired with a neutral twin carrying the same classes,\n// so only rules that target the element itself can make them differ\nconst PROBES = [\n ...['h1', 'h2', 'h3', 'h4', 'h5', 'h6'].map(element => ({\n element,\n twin: 'div',\n className: 'eds-heading eds-heading--title-2',\n component: 'Heading',\n })),\n {\n element: 'p',\n twin: 'div',\n className: 'eds-text eds-text--paragraph',\n component: 'Text',\n },\n {\n element: 'a',\n twin: 'span',\n className: 'eds-text--link',\n component: 'Link',\n },\n {\n element: 'ul',\n twin: 'div',\n className: 'eds-text eds-text--unordered-list',\n component: 'UnorderedList',\n },\n {\n element: 'code',\n twin: 'span',\n className: 'eds-text eds-text--code',\n component: 'Text variant=\"code\"',\n },\n];\n\n/** Finds global CSS in the app that overrides the beta typography. Empty when the beta styles aren't loaded. */\nexport function findGlobalStyleConflicts(): string[] {\n const host = document.createElement('div');\n host.setAttribute('aria-hidden', 'true');\n host.style.cssText =\n 'position:absolute;top:0;left:-10000px;width:600px;visibility:hidden;pointer-events:none';\n\n const container = document.createElement('div');\n container.className = 'eds-text-container';\n container.innerHTML =\n '<p class=\"eds-text eds-text--paragraph\">x</p><p class=\"eds-text eds-text--paragraph\">x</p>';\n host.append(container);\n\n const pairs = PROBES.map(probe => {\n const [element, twin] = [probe.element, probe.twin].map(tag => {\n const node = document.createElement(tag);\n node.className = probe.className;\n node.textContent = 'x';\n host.append(node);\n return node;\n });\n return { probe, element, twin };\n });\n\n document.body.append(host);\n const conflicts: string[] = [];\n\n if (window.getComputedStyle(container).display === 'flow-root') {\n if (\n window.getComputedStyle(container.lastElementChild as Element)\n .marginTop === '0px'\n ) {\n conflicts.push(\n 'TextContainer has no space between texts. Often a reset like `* { margin: 0 }`.',\n );\n }\n pairs.forEach(({ probe, element, twin }) => {\n const elementStyle = window.getComputedStyle(element);\n const twinStyle = window.getComputedStyle(twin);\n const changed = COMPARED_PROPERTIES.filter(\n property =>\n elementStyle.getPropertyValue(property) !==\n twinStyle.getPropertyValue(property),\n );\n if (changed.length > 0) {\n conflicts.push(\n `\\`${probe.element} { ${changed.join('; ')} }\\` overrides ${\n probe.component\n }.`,\n );\n }\n });\n }\n\n host.remove();\n return conflicts;\n}\n\nlet checkTimeoutId: number | undefined;\n\n/** Warns the developer once if global CSS in the app overrides the beta typography */\nexport function warnAboutGlobalStyles(): void {\n // Plain process.env.NODE_ENV, so bundlers replace it and drop the check from production builds\n if (process.env.NODE_ENV === 'production') return;\n if (\n typeof window === 'undefined' ||\n (typeof process !== 'undefined' && process.env.TEST === 'true') ||\n checkTimeoutId !== undefined\n ) {\n return;\n }\n\n // Wait for the stylesheets, like warnAboutMissingStyles\n checkTimeoutId = window.setTimeout(() => {\n const conflicts = findGlobalStyleConflicts();\n if (conflicts.length === 0) return;\n console.warn(\n `@entur/typography: global CSS in your app overrides the typography components.\n\n${conflicts.map(conflict => ` - ${conflict}`).join('\\n')}\n\nCSS outside a cascade layer always wins over the typography, which sits in layers. Move resets into \\`@layer core.reset\\` and element styles into \\`@layer core.base\\`, with the layer order declared first:\n${GUIDE_URL}`,\n );\n }, 1000);\n}\n"],"names":[],"mappings":"AAAA,MAAM,YACJ;AAEF,MAAM,sBAAsB;AAAA,EAC1B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAIA,MAAM,SAAS;AAAA,EACb,GAAG,CAAC,MAAM,MAAM,MAAM,MAAM,MAAM,IAAI,EAAE,IAAI,CAAA,aAAY;AAAA,IACtD;AAAA,IACA,MAAM;AAAA,IACN,WAAW;AAAA,IACX,WAAW;AAAA,EAAA,EACX;AAAA,EACF;AAAA,IACE,SAAS;AAAA,IACT,MAAM;AAAA,IACN,WAAW;AAAA,IACX,WAAW;AAAA,EAAA;AAAA,EAEb;AAAA,IACE,SAAS;AAAA,IACT,MAAM;AAAA,IACN,WAAW;AAAA,IACX,WAAW;AAAA,EAAA;AAAA,EAEb;AAAA,IACE,SAAS;AAAA,IACT,MAAM;AAAA,IACN,WAAW;AAAA,IACX,WAAW;AAAA,EAAA;AAAA,EAEb;AAAA,IACE,SAAS;AAAA,IACT,MAAM;AAAA,IACN,WAAW;AAAA,IACX,WAAW;AAAA,EAAA;AAEf;AAGO,SAAS,2BAAqC;AACnD,QAAM,OAAO,SAAS,cAAc,KAAK;AACzC,OAAK,aAAa,eAAe,MAAM;AACvC,OAAK,MAAM,UACT;AAEF,QAAM,YAAY,SAAS,cAAc,KAAK;AAC9C,YAAU,YAAY;AACtB,YAAU,YACR;AACF,OAAK,OAAO,SAAS;AAErB,QAAM,QAAQ,OAAO,IAAI,CAAA,UAAS;AAChC,UAAM,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,SAAS,MAAM,IAAI,EAAE,IAAI,CAAA,QAAO;AAC7D,YAAM,OAAO,SAAS,cAAc,GAAG;AACvC,WAAK,YAAY,MAAM;AACvB,WAAK,cAAc;AACnB,WAAK,OAAO,IAAI;AAChB,aAAO;AAAA,IACT,CAAC;AACD,WAAO,EAAE,OAAO,SAAS,KAAA;AAAA,EAC3B,CAAC;AAED,WAAS,KAAK,OAAO,IAAI;AACzB,QAAM,YAAsB,CAAA;AAE5B,MAAI,OAAO,iBAAiB,SAAS,EAAE,YAAY,aAAa;AAC9D,QACE,OAAO,iBAAiB,UAAU,gBAA2B,EAC1D,cAAc,OACjB;AACA,gBAAU;AAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AACA,UAAM,QAAQ,CAAC,EAAE,OAAO,SAAS,WAAW;AAC1C,YAAM,eAAe,OAAO,iBAAiB,OAAO;AACpD,YAAM,YAAY,OAAO,iBAAiB,IAAI;AAC9C,YAAM,UAAU,oBAAoB;AAAA,QAClC,cACE,aAAa,iBAAiB,QAAQ,MACtC,UAAU,iBAAiB,QAAQ;AAAA,MAAA;AAEvC,UAAI,QAAQ,SAAS,GAAG;AACtB,kBAAU;AAAA,UACR,KAAK,MAAM,OAAO,MAAM,QAAQ,KAAK,IAAI,CAAC,kBACxC,MAAM,SACR;AAAA,QAAA;AAAA,MAEJ;AAAA,IACF,CAAC;AAAA,EACH;AAEA,OAAK,OAAA;AACL,SAAO;AACT;AAEA,IAAI;AAGG,SAAS,wBAA8B;AAE5C,MAAI,QAAQ,IAAI,aAAa,aAAc;AAC3C,MACE,OAAO,WAAW,eACjB,OAAO,YAAY,eAAe,QAAQ,IAAI,SAAS,UACxD,mBAAmB,QACnB;AACA;AAAA,EACF;AAGA,mBAAiB,OAAO,WAAW,MAAM;AACvC,UAAM,YAAY,yBAAA;AAClB,QAAI,UAAU,WAAW,EAAG;AAC5B,YAAQ;AAAA,MACN;AAAA;AAAA,EAEJ,UAAU,IAAI,CAAA,aAAY,OAAO,QAAQ,EAAE,EAAE,KAAK,IAAI,CAAC;AAAA;AAAA;AAAA,EAGvD,SAAS;AAAA,IAAA;AAAA,EAET,GAAG,GAAI;AACT;"}
|