@atlaskit/heading 0.1.17 → 1.0.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/CHANGELOG.md +17 -0
- package/dist/cjs/heading-context.js +51 -0
- package/dist/cjs/heading.js +61 -89
- package/dist/cjs/index.js +9 -1
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/heading-context.js +34 -0
- package/dist/es2019/heading.js +61 -88
- package/dist/es2019/index.js +2 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/heading-context.js +33 -0
- package/dist/esm/heading.js +61 -88
- package/dist/esm/index.js +2 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/heading-context.d.ts +27 -0
- package/dist/types/index.d.ts +1 -0
- package/package.json +8 -14
- package/report.api.md +33 -15
- package/tmp/api-report-tmp.d.ts +37 -0
- package/dist/types-ts4.0/heading.d.ts +0 -20
- package/dist/types-ts4.0/index.d.ts +0 -2
- package/dist/types-ts4.0/types.d.ts +0 -26
- package/dist/types-ts4.0/utils.d.ts +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @atlaskit/heading
|
|
2
2
|
|
|
3
|
+
## 1.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [`7d92ed50264`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d92ed50264) - [ux] This package is still considered to be in an experimental state and is discouraged for use in production. The major is to simplify consumption and versioning in product.
|
|
8
|
+
|
|
9
|
+
Other changes:
|
|
10
|
+
|
|
11
|
+
- Introduction of a `HeadingContext` provider to aid with creating the right semantic structure for headings.
|
|
12
|
+
- Migrated internals to use `@compiled/react` from `@emotion/react`.
|
|
13
|
+
|
|
14
|
+
## 0.1.18
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- [`bc989043572`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bc989043572) - Internal changes to apply spacing tokens. This should be a no-op change.
|
|
19
|
+
|
|
3
20
|
## 0.1.17
|
|
4
21
|
|
|
5
22
|
### Patch Changes
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _typeof = require("@babel/runtime/helpers/typeof");
|
|
4
|
+
|
|
5
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.useHeadingElement = exports.default = void 0;
|
|
9
|
+
|
|
10
|
+
var _react = _interopRequireWildcard(require("react"));
|
|
11
|
+
|
|
12
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
13
|
+
|
|
14
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
15
|
+
|
|
16
|
+
var HeadingContext = /*#__PURE__*/(0, _react.createContext)(undefined);
|
|
17
|
+
|
|
18
|
+
var useHeadingElement = function useHeadingElement() {
|
|
19
|
+
return Math.min((0, _react.useContext)(HeadingContext) || 0, 6);
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
exports.useHeadingElement = useHeadingElement;
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* __Heading context__
|
|
26
|
+
*
|
|
27
|
+
* The HeadingContext
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```tsx
|
|
31
|
+
* // Will correctly infer the heading level
|
|
32
|
+
* <HeadingContext value={1}>
|
|
33
|
+
* <Heading>H1</Heading>
|
|
34
|
+
* <HeadingContext>
|
|
35
|
+
* <Heading>H2</Heading>
|
|
36
|
+
* </HeadingContext>
|
|
37
|
+
* </HeadingContext>
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
var HeadingContextProvider = function HeadingContextProvider(_ref) {
|
|
41
|
+
var children = _ref.children,
|
|
42
|
+
value = _ref.value;
|
|
43
|
+
var parentHeadingLevel = useHeadingElement();
|
|
44
|
+
var headingLevel = parentHeadingLevel + 1;
|
|
45
|
+
return /*#__PURE__*/_react.default.createElement(HeadingContext.Provider, {
|
|
46
|
+
value: value || headingLevel
|
|
47
|
+
}, children);
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
var _default = HeadingContextProvider;
|
|
51
|
+
exports.default = _default;
|
package/dist/cjs/heading.js
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
/* heading.tsx generated by @compiled/babel-plugin v0.15.0 */
|
|
2
|
+
|
|
3
|
+
/** @jsx jsx */
|
|
1
4
|
"use strict";
|
|
2
5
|
|
|
3
6
|
Object.defineProperty(exports, "__esModule", {
|
|
@@ -5,13 +8,40 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
8
|
});
|
|
6
9
|
exports.default = void 0;
|
|
7
10
|
|
|
8
|
-
var
|
|
11
|
+
var _runtime = require("@compiled/react/runtime");
|
|
9
12
|
|
|
10
|
-
var
|
|
13
|
+
var _react = require("@compiled/react");
|
|
11
14
|
|
|
12
|
-
var
|
|
15
|
+
var _headingContext = require("./heading-context");
|
|
13
16
|
|
|
14
|
-
|
|
17
|
+
var _28 = "._syaz1wmz{color:var(--ds-text-subtlest,#6b778c)}";
|
|
18
|
+
var _27 = "._syaz15cr{color:var(--ds-text-inverse,#fff)}";
|
|
19
|
+
var _26 = "._vwz41ylp{line-height:40px}";
|
|
20
|
+
var _25 = "._1wybldb6{font-size:35px}";
|
|
21
|
+
var _24 = "._vwz4zwfg{line-height:2pc}";
|
|
22
|
+
var _23 = "._1wyb1pa9{font-size:29px}";
|
|
23
|
+
var _22 = "._vwz41f4h{line-height:28px}";
|
|
24
|
+
var _21 = "._1dyzz5jk{letter-spacing:-.01em}";
|
|
25
|
+
var _20 = "._1wyb1tcg{font-size:24px}";
|
|
26
|
+
var _19 = "._vwz41tcg{line-height:24px}";
|
|
27
|
+
var _18 = "._1dyzvkfx{letter-spacing:-.008em}";
|
|
28
|
+
var _17 = "._k48pbfng{font-weight:500}";
|
|
29
|
+
var _16 = "._1wybgktf{font-size:20px}";
|
|
30
|
+
var _15 = "._vwz4gktf{line-height:20px}";
|
|
31
|
+
var _14 = "._1dyzqdok{letter-spacing:-.006em}";
|
|
32
|
+
var _13 = "._1wyb7vkz{font-size:1pc}";
|
|
33
|
+
var _12 = "._1dyz44hb{letter-spacing:-.003em}";
|
|
34
|
+
var _11 = "._1wybdlk8{font-size:14px}";
|
|
35
|
+
var _10 = "._1p1dangw{text-transform:uppercase}";
|
|
36
|
+
var _9 = "._k48pni7l{font-weight:600}";
|
|
37
|
+
var _8 = "._1wyb1crf{font-size:9pt}";
|
|
38
|
+
var _7 = "._vwz47vkz{line-height:1pc}";
|
|
39
|
+
var _6 = "._1dyzidpf{letter-spacing:0}";
|
|
40
|
+
var _5 = "._k48p1fw0{font-weight:700}";
|
|
41
|
+
var _4 = "._1wyb1skh{font-size:11px}";
|
|
42
|
+
var _3 = "._syaz1fxt{color:var(--ds-text,#172b4d)}";
|
|
43
|
+
var _2 = "._otyryy18{margin-bottom:var(--ds-scale-0,0)}";
|
|
44
|
+
var _ = "._19pkyy18{margin-top:var(--ds-scale-0,0)}";
|
|
15
45
|
// https://atlassian.design/foundations/typography
|
|
16
46
|
var levelMap = {
|
|
17
47
|
h900: 'h1',
|
|
@@ -25,86 +55,18 @@ var levelMap = {
|
|
|
25
55
|
h200: 'div',
|
|
26
56
|
h100: 'div'
|
|
27
57
|
};
|
|
28
|
-
var headingResetStyles =
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
var
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
var
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
letterSpacing: '-0.01em',
|
|
41
|
-
lineHeight: (0, _utils.lh)(29, 32)
|
|
42
|
-
});
|
|
43
|
-
var h700Styles = (0, _react.css)({
|
|
44
|
-
fontSize: 24,
|
|
45
|
-
fontWeight: 500,
|
|
46
|
-
letterSpacing: '-0.01em',
|
|
47
|
-
lineHeight: (0, _utils.lh)(24, 28)
|
|
48
|
-
});
|
|
49
|
-
var h600Styles = (0, _react.css)({
|
|
50
|
-
fontSize: 20,
|
|
51
|
-
fontWeight: 500,
|
|
52
|
-
letterSpacing: '-0.008em',
|
|
53
|
-
lineHeight: (0, _utils.lh)(20, 24)
|
|
54
|
-
});
|
|
55
|
-
var h500Styles = (0, _react.css)({
|
|
56
|
-
fontSize: 16,
|
|
57
|
-
fontWeight: 600,
|
|
58
|
-
letterSpacing: '-0.006em',
|
|
59
|
-
lineHeight: (0, _utils.lh)(16, 20)
|
|
60
|
-
});
|
|
61
|
-
var h400Styles = (0, _react.css)({
|
|
62
|
-
fontSize: 14,
|
|
63
|
-
fontWeight: 600,
|
|
64
|
-
letterSpacing: '-0.003em',
|
|
65
|
-
lineHeight: (0, _utils.lh)(14, 16)
|
|
66
|
-
});
|
|
67
|
-
var h300Styles = (0, _react.css)({
|
|
68
|
-
fontSize: 12,
|
|
69
|
-
fontWeight: 600,
|
|
70
|
-
letterSpacing: 0,
|
|
71
|
-
lineHeight: (0, _utils.lh)(12, 16),
|
|
72
|
-
textTransform: 'uppercase'
|
|
73
|
-
});
|
|
74
|
-
var h200Styles = (0, _react.css)({
|
|
75
|
-
fontSize: 12,
|
|
76
|
-
fontWeight: 600,
|
|
77
|
-
letterSpacing: 0,
|
|
78
|
-
lineHeight: (0, _utils.lh)(12, 16)
|
|
79
|
-
});
|
|
80
|
-
var h100Styles = (0, _react.css)({
|
|
81
|
-
fontSize: 11,
|
|
82
|
-
fontWeight: 700,
|
|
83
|
-
letterSpacing: 0,
|
|
84
|
-
lineHeight: (0, _utils.lh)(11, 16)
|
|
85
|
-
});
|
|
86
|
-
var styleMap = {
|
|
87
|
-
h900: h900Styles,
|
|
88
|
-
h800: h800Styles,
|
|
89
|
-
h700: h700Styles,
|
|
90
|
-
h600: h600Styles,
|
|
91
|
-
h500: h500Styles,
|
|
92
|
-
h400: h400Styles,
|
|
93
|
-
h300: h300Styles,
|
|
94
|
-
h200: h200Styles,
|
|
95
|
-
h100: h100Styles
|
|
96
|
-
};
|
|
97
|
-
var colorStyleMap = {
|
|
98
|
-
default: (0, _react.css)({
|
|
99
|
-
color: "var(--ds-text, ".concat(_colors.N800, ")")
|
|
100
|
-
}),
|
|
101
|
-
inverse: (0, _react.css)({
|
|
102
|
-
color: "var(--ds-text-inverse, ".concat(_colors.N0, ")")
|
|
103
|
-
}),
|
|
104
|
-
subtlest: (0, _react.css)({
|
|
105
|
-
color: "var(--ds-text-subtlest, ".concat(_colors.N200, ")")
|
|
106
|
-
})
|
|
107
|
-
};
|
|
58
|
+
var headingResetStyles = null;
|
|
59
|
+
var h900Styles = null;
|
|
60
|
+
var h800Styles = null;
|
|
61
|
+
var h700Styles = null;
|
|
62
|
+
var h600Styles = null;
|
|
63
|
+
var h500Styles = null;
|
|
64
|
+
var h400Styles = null;
|
|
65
|
+
var h300Styles = null;
|
|
66
|
+
var h200Styles = null;
|
|
67
|
+
var h100Styles = null;
|
|
68
|
+
var inverseStyles = null;
|
|
69
|
+
var subtlestStyles = null;
|
|
108
70
|
/**
|
|
109
71
|
* __Heading__
|
|
110
72
|
*
|
|
@@ -134,13 +96,23 @@ var Heading = function Heading(_ref) {
|
|
|
134
96
|
throw new Error('`as` prop should be a string.');
|
|
135
97
|
}
|
|
136
98
|
|
|
137
|
-
var
|
|
99
|
+
var hLevel = (0, _headingContext.useHeadingElement)();
|
|
100
|
+
/**
|
|
101
|
+
* Order here is important, we for now apply
|
|
102
|
+
* 1. user choice
|
|
103
|
+
* 2. inferred a11y level
|
|
104
|
+
* 3. default final fallback
|
|
105
|
+
*/
|
|
106
|
+
|
|
107
|
+
var Markup = as || hLevel && "h".concat(hLevel) || levelMap[level];
|
|
138
108
|
var isSubtleHeading = level === 'h200' || level === 'h100';
|
|
139
|
-
return (0, _react.jsx)(Markup, {
|
|
109
|
+
return (0, _react.jsx)(_runtime.CC, null, (0, _react.jsx)(_runtime.CS, null, [_, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28]), (0, _react.jsx)(Markup, {
|
|
140
110
|
id: id,
|
|
141
|
-
"data-testid": testId
|
|
142
|
-
|
|
143
|
-
|
|
111
|
+
"data-testid": testId // @ts-ignore
|
|
112
|
+
// Resolved by https://github.com/atlassian-labs/compiled/pull/1321
|
|
113
|
+
,
|
|
114
|
+
className: (0, _runtime.ax)(["_19pkyy18 _otyryy18 _syaz1fxt", level === 'h100' && "_1wyb1skh _k48p1fw0 _1dyzidpf _vwz47vkz", level === 'h200' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz", level === 'h300' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz _1p1dangw", level === 'h400' && "_1wybdlk8 _k48pni7l _1dyz44hb _vwz47vkz", level === 'h500' && "_1wyb7vkz _k48pni7l _1dyzqdok _vwz4gktf", level === 'h600' && "_1wybgktf _k48pbfng _1dyzvkfx _vwz41tcg", level === 'h700' && "_1wyb1tcg _k48pbfng _1dyzz5jk _vwz41f4h", level === 'h800' && "_1wyb1pa9 _k48pni7l _1dyzz5jk _vwz4zwfg", level === 'h900' && "_1wybldb6 _k48pbfng _1dyzz5jk _vwz41ylp", color === 'inverse' && "_syaz15cr", color === 'default' && isSubtleHeading && "_syaz1wmz"])
|
|
115
|
+
}, children));
|
|
144
116
|
};
|
|
145
117
|
|
|
146
118
|
var _default = Heading;
|
package/dist/cjs/index.js
CHANGED
|
@@ -5,6 +5,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", {
|
|
6
6
|
value: true
|
|
7
7
|
});
|
|
8
|
+
Object.defineProperty(exports, "HeadingContextProvider", {
|
|
9
|
+
enumerable: true,
|
|
10
|
+
get: function get() {
|
|
11
|
+
return _headingContext.default;
|
|
12
|
+
}
|
|
13
|
+
});
|
|
8
14
|
Object.defineProperty(exports, "default", {
|
|
9
15
|
enumerable: true,
|
|
10
16
|
get: function get() {
|
|
@@ -12,4 +18,6 @@ Object.defineProperty(exports, "default", {
|
|
|
12
18
|
}
|
|
13
19
|
});
|
|
14
20
|
|
|
15
|
-
var _heading = _interopRequireDefault(require("./heading"));
|
|
21
|
+
var _heading = _interopRequireDefault(require("./heading"));
|
|
22
|
+
|
|
23
|
+
var _headingContext = _interopRequireDefault(require("./heading-context"));
|
package/dist/cjs/version.json
CHANGED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import React, { createContext, useContext } from 'react';
|
|
2
|
+
const HeadingContext = /*#__PURE__*/createContext(undefined);
|
|
3
|
+
export const useHeadingElement = () => {
|
|
4
|
+
return Math.min(useContext(HeadingContext) || 0, 6);
|
|
5
|
+
};
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* __Heading context__
|
|
9
|
+
*
|
|
10
|
+
* The HeadingContext
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```tsx
|
|
14
|
+
* // Will correctly infer the heading level
|
|
15
|
+
* <HeadingContext value={1}>
|
|
16
|
+
* <Heading>H1</Heading>
|
|
17
|
+
* <HeadingContext>
|
|
18
|
+
* <Heading>H2</Heading>
|
|
19
|
+
* </HeadingContext>
|
|
20
|
+
* </HeadingContext>
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
const HeadingContextProvider = ({
|
|
24
|
+
children,
|
|
25
|
+
value
|
|
26
|
+
}) => {
|
|
27
|
+
const parentHeadingLevel = useHeadingElement();
|
|
28
|
+
const headingLevel = parentHeadingLevel + 1;
|
|
29
|
+
return /*#__PURE__*/React.createElement(HeadingContext.Provider, {
|
|
30
|
+
value: value || headingLevel
|
|
31
|
+
}, children);
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
export default HeadingContextProvider;
|
package/dist/es2019/heading.js
CHANGED
|
@@ -1,8 +1,39 @@
|
|
|
1
|
+
/* heading.tsx generated by @compiled/babel-plugin v0.15.0 */
|
|
2
|
+
|
|
1
3
|
/** @jsx jsx */
|
|
2
|
-
import { css, jsx } from '@emotion/react';
|
|
3
|
-
import { N0, N200, N800 } from '@atlaskit/theme/colors';
|
|
4
|
-
import { lh } from './utils'; // https://atlassian.design/foundations/typography
|
|
5
4
|
|
|
5
|
+
import { ax, ix, CC, CS } from "@compiled/react/runtime";
|
|
6
|
+
import { jsx } from '@compiled/react';
|
|
7
|
+
import { useHeadingElement } from './heading-context';
|
|
8
|
+
const _28 = "._syaz1wmz{color:var(--ds-text-subtlest,#6b778c)}";
|
|
9
|
+
const _27 = "._syaz15cr{color:var(--ds-text-inverse,#fff)}";
|
|
10
|
+
const _26 = "._vwz41ylp{line-height:40px}";
|
|
11
|
+
const _25 = "._1wybldb6{font-size:35px}";
|
|
12
|
+
const _24 = "._vwz4zwfg{line-height:2pc}";
|
|
13
|
+
const _23 = "._1wyb1pa9{font-size:29px}";
|
|
14
|
+
const _22 = "._vwz41f4h{line-height:28px}";
|
|
15
|
+
const _21 = "._1dyzz5jk{letter-spacing:-.01em}";
|
|
16
|
+
const _20 = "._1wyb1tcg{font-size:24px}";
|
|
17
|
+
const _19 = "._vwz41tcg{line-height:24px}";
|
|
18
|
+
const _18 = "._1dyzvkfx{letter-spacing:-.008em}";
|
|
19
|
+
const _17 = "._k48pbfng{font-weight:500}";
|
|
20
|
+
const _16 = "._1wybgktf{font-size:20px}";
|
|
21
|
+
const _15 = "._vwz4gktf{line-height:20px}";
|
|
22
|
+
const _14 = "._1dyzqdok{letter-spacing:-.006em}";
|
|
23
|
+
const _13 = "._1wyb7vkz{font-size:1pc}";
|
|
24
|
+
const _12 = "._1dyz44hb{letter-spacing:-.003em}";
|
|
25
|
+
const _11 = "._1wybdlk8{font-size:14px}";
|
|
26
|
+
const _10 = "._1p1dangw{text-transform:uppercase}";
|
|
27
|
+
const _9 = "._k48pni7l{font-weight:600}";
|
|
28
|
+
const _8 = "._1wyb1crf{font-size:9pt}";
|
|
29
|
+
const _7 = "._vwz47vkz{line-height:1pc}";
|
|
30
|
+
const _6 = "._1dyzidpf{letter-spacing:0}";
|
|
31
|
+
const _5 = "._k48p1fw0{font-weight:700}";
|
|
32
|
+
const _4 = "._1wyb1skh{font-size:11px}";
|
|
33
|
+
const _3 = "._syaz1fxt{color:var(--ds-text,#172b4d)}";
|
|
34
|
+
const _2 = "._otyryy18{margin-bottom:var(--ds-scale-0,0)}";
|
|
35
|
+
const _ = "._19pkyy18{margin-top:var(--ds-scale-0,0)}";
|
|
36
|
+
// https://atlassian.design/foundations/typography
|
|
6
37
|
const levelMap = {
|
|
7
38
|
h900: 'h1',
|
|
8
39
|
h800: 'h1',
|
|
@@ -15,86 +46,18 @@ const levelMap = {
|
|
|
15
46
|
h200: 'div',
|
|
16
47
|
h100: 'div'
|
|
17
48
|
};
|
|
18
|
-
const headingResetStyles =
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
const
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
const
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
letterSpacing: '-0.01em',
|
|
31
|
-
lineHeight: lh(29, 32)
|
|
32
|
-
});
|
|
33
|
-
const h700Styles = css({
|
|
34
|
-
fontSize: 24,
|
|
35
|
-
fontWeight: 500,
|
|
36
|
-
letterSpacing: '-0.01em',
|
|
37
|
-
lineHeight: lh(24, 28)
|
|
38
|
-
});
|
|
39
|
-
const h600Styles = css({
|
|
40
|
-
fontSize: 20,
|
|
41
|
-
fontWeight: 500,
|
|
42
|
-
letterSpacing: '-0.008em',
|
|
43
|
-
lineHeight: lh(20, 24)
|
|
44
|
-
});
|
|
45
|
-
const h500Styles = css({
|
|
46
|
-
fontSize: 16,
|
|
47
|
-
fontWeight: 600,
|
|
48
|
-
letterSpacing: '-0.006em',
|
|
49
|
-
lineHeight: lh(16, 20)
|
|
50
|
-
});
|
|
51
|
-
const h400Styles = css({
|
|
52
|
-
fontSize: 14,
|
|
53
|
-
fontWeight: 600,
|
|
54
|
-
letterSpacing: '-0.003em',
|
|
55
|
-
lineHeight: lh(14, 16)
|
|
56
|
-
});
|
|
57
|
-
const h300Styles = css({
|
|
58
|
-
fontSize: 12,
|
|
59
|
-
fontWeight: 600,
|
|
60
|
-
letterSpacing: 0,
|
|
61
|
-
lineHeight: lh(12, 16),
|
|
62
|
-
textTransform: 'uppercase'
|
|
63
|
-
});
|
|
64
|
-
const h200Styles = css({
|
|
65
|
-
fontSize: 12,
|
|
66
|
-
fontWeight: 600,
|
|
67
|
-
letterSpacing: 0,
|
|
68
|
-
lineHeight: lh(12, 16)
|
|
69
|
-
});
|
|
70
|
-
const h100Styles = css({
|
|
71
|
-
fontSize: 11,
|
|
72
|
-
fontWeight: 700,
|
|
73
|
-
letterSpacing: 0,
|
|
74
|
-
lineHeight: lh(11, 16)
|
|
75
|
-
});
|
|
76
|
-
const styleMap = {
|
|
77
|
-
h900: h900Styles,
|
|
78
|
-
h800: h800Styles,
|
|
79
|
-
h700: h700Styles,
|
|
80
|
-
h600: h600Styles,
|
|
81
|
-
h500: h500Styles,
|
|
82
|
-
h400: h400Styles,
|
|
83
|
-
h300: h300Styles,
|
|
84
|
-
h200: h200Styles,
|
|
85
|
-
h100: h100Styles
|
|
86
|
-
};
|
|
87
|
-
const colorStyleMap = {
|
|
88
|
-
default: css({
|
|
89
|
-
color: `var(--ds-text, ${N800})`
|
|
90
|
-
}),
|
|
91
|
-
inverse: css({
|
|
92
|
-
color: `var(--ds-text-inverse, ${N0})`
|
|
93
|
-
}),
|
|
94
|
-
subtlest: css({
|
|
95
|
-
color: `var(--ds-text-subtlest, ${N200})`
|
|
96
|
-
})
|
|
97
|
-
};
|
|
49
|
+
const headingResetStyles = null;
|
|
50
|
+
const h900Styles = null;
|
|
51
|
+
const h800Styles = null;
|
|
52
|
+
const h700Styles = null;
|
|
53
|
+
const h600Styles = null;
|
|
54
|
+
const h500Styles = null;
|
|
55
|
+
const h400Styles = null;
|
|
56
|
+
const h300Styles = null;
|
|
57
|
+
const h200Styles = null;
|
|
58
|
+
const h100Styles = null;
|
|
59
|
+
const inverseStyles = null;
|
|
60
|
+
const subtlestStyles = null;
|
|
98
61
|
/**
|
|
99
62
|
* __Heading__
|
|
100
63
|
*
|
|
@@ -123,13 +86,23 @@ const Heading = ({
|
|
|
123
86
|
throw new Error('`as` prop should be a string.');
|
|
124
87
|
}
|
|
125
88
|
|
|
126
|
-
const
|
|
89
|
+
const hLevel = useHeadingElement();
|
|
90
|
+
/**
|
|
91
|
+
* Order here is important, we for now apply
|
|
92
|
+
* 1. user choice
|
|
93
|
+
* 2. inferred a11y level
|
|
94
|
+
* 3. default final fallback
|
|
95
|
+
*/
|
|
96
|
+
|
|
97
|
+
const Markup = as || hLevel && `h${hLevel}` || levelMap[level];
|
|
127
98
|
const isSubtleHeading = level === 'h200' || level === 'h100';
|
|
128
|
-
return jsx(Markup, {
|
|
99
|
+
return jsx(CC, null, jsx(CS, null, [_, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28]), jsx(Markup, {
|
|
129
100
|
id: id,
|
|
130
|
-
"data-testid": testId
|
|
131
|
-
|
|
132
|
-
|
|
101
|
+
"data-testid": testId // @ts-ignore
|
|
102
|
+
// Resolved by https://github.com/atlassian-labs/compiled/pull/1321
|
|
103
|
+
,
|
|
104
|
+
className: ax(["_19pkyy18 _otyryy18 _syaz1fxt", level === 'h100' && "_1wyb1skh _k48p1fw0 _1dyzidpf _vwz47vkz", level === 'h200' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz", level === 'h300' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz _1p1dangw", level === 'h400' && "_1wybdlk8 _k48pni7l _1dyz44hb _vwz47vkz", level === 'h500' && "_1wyb7vkz _k48pni7l _1dyzqdok _vwz4gktf", level === 'h600' && "_1wybgktf _k48pbfng _1dyzvkfx _vwz41tcg", level === 'h700' && "_1wyb1tcg _k48pbfng _1dyzz5jk _vwz41f4h", level === 'h800' && "_1wyb1pa9 _k48pni7l _1dyzz5jk _vwz4zwfg", level === 'h900' && "_1wybldb6 _k48pbfng _1dyzz5jk _vwz41ylp", color === 'inverse' && "_syaz15cr", color === 'default' && isSubtleHeading && "_syaz1wmz"])
|
|
105
|
+
}, children));
|
|
133
106
|
};
|
|
134
107
|
|
|
135
108
|
export default Heading;
|
package/dist/es2019/index.js
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
export { default } from './heading';
|
|
1
|
+
export { default } from './heading';
|
|
2
|
+
export { default as HeadingContextProvider } from './heading-context';
|
package/dist/es2019/version.json
CHANGED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import React, { createContext, useContext } from 'react';
|
|
2
|
+
var HeadingContext = /*#__PURE__*/createContext(undefined);
|
|
3
|
+
export var useHeadingElement = function useHeadingElement() {
|
|
4
|
+
return Math.min(useContext(HeadingContext) || 0, 6);
|
|
5
|
+
};
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* __Heading context__
|
|
9
|
+
*
|
|
10
|
+
* The HeadingContext
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```tsx
|
|
14
|
+
* // Will correctly infer the heading level
|
|
15
|
+
* <HeadingContext value={1}>
|
|
16
|
+
* <Heading>H1</Heading>
|
|
17
|
+
* <HeadingContext>
|
|
18
|
+
* <Heading>H2</Heading>
|
|
19
|
+
* </HeadingContext>
|
|
20
|
+
* </HeadingContext>
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
var HeadingContextProvider = function HeadingContextProvider(_ref) {
|
|
24
|
+
var children = _ref.children,
|
|
25
|
+
value = _ref.value;
|
|
26
|
+
var parentHeadingLevel = useHeadingElement();
|
|
27
|
+
var headingLevel = parentHeadingLevel + 1;
|
|
28
|
+
return /*#__PURE__*/React.createElement(HeadingContext.Provider, {
|
|
29
|
+
value: value || headingLevel
|
|
30
|
+
}, children);
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
export default HeadingContextProvider;
|
package/dist/esm/heading.js
CHANGED
|
@@ -1,8 +1,39 @@
|
|
|
1
|
+
/* heading.tsx generated by @compiled/babel-plugin v0.15.0 */
|
|
2
|
+
|
|
1
3
|
/** @jsx jsx */
|
|
2
|
-
import { css, jsx } from '@emotion/react';
|
|
3
|
-
import { N0, N200, N800 } from '@atlaskit/theme/colors';
|
|
4
|
-
import { lh } from './utils'; // https://atlassian.design/foundations/typography
|
|
5
4
|
|
|
5
|
+
import { ax, ix, CC, CS } from "@compiled/react/runtime";
|
|
6
|
+
import { jsx } from '@compiled/react';
|
|
7
|
+
import { useHeadingElement } from './heading-context';
|
|
8
|
+
var _28 = "._syaz1wmz{color:var(--ds-text-subtlest,#6b778c)}";
|
|
9
|
+
var _27 = "._syaz15cr{color:var(--ds-text-inverse,#fff)}";
|
|
10
|
+
var _26 = "._vwz41ylp{line-height:40px}";
|
|
11
|
+
var _25 = "._1wybldb6{font-size:35px}";
|
|
12
|
+
var _24 = "._vwz4zwfg{line-height:2pc}";
|
|
13
|
+
var _23 = "._1wyb1pa9{font-size:29px}";
|
|
14
|
+
var _22 = "._vwz41f4h{line-height:28px}";
|
|
15
|
+
var _21 = "._1dyzz5jk{letter-spacing:-.01em}";
|
|
16
|
+
var _20 = "._1wyb1tcg{font-size:24px}";
|
|
17
|
+
var _19 = "._vwz41tcg{line-height:24px}";
|
|
18
|
+
var _18 = "._1dyzvkfx{letter-spacing:-.008em}";
|
|
19
|
+
var _17 = "._k48pbfng{font-weight:500}";
|
|
20
|
+
var _16 = "._1wybgktf{font-size:20px}";
|
|
21
|
+
var _15 = "._vwz4gktf{line-height:20px}";
|
|
22
|
+
var _14 = "._1dyzqdok{letter-spacing:-.006em}";
|
|
23
|
+
var _13 = "._1wyb7vkz{font-size:1pc}";
|
|
24
|
+
var _12 = "._1dyz44hb{letter-spacing:-.003em}";
|
|
25
|
+
var _11 = "._1wybdlk8{font-size:14px}";
|
|
26
|
+
var _10 = "._1p1dangw{text-transform:uppercase}";
|
|
27
|
+
var _9 = "._k48pni7l{font-weight:600}";
|
|
28
|
+
var _8 = "._1wyb1crf{font-size:9pt}";
|
|
29
|
+
var _7 = "._vwz47vkz{line-height:1pc}";
|
|
30
|
+
var _6 = "._1dyzidpf{letter-spacing:0}";
|
|
31
|
+
var _5 = "._k48p1fw0{font-weight:700}";
|
|
32
|
+
var _4 = "._1wyb1skh{font-size:11px}";
|
|
33
|
+
var _3 = "._syaz1fxt{color:var(--ds-text,#172b4d)}";
|
|
34
|
+
var _2 = "._otyryy18{margin-bottom:var(--ds-scale-0,0)}";
|
|
35
|
+
var _ = "._19pkyy18{margin-top:var(--ds-scale-0,0)}";
|
|
36
|
+
// https://atlassian.design/foundations/typography
|
|
6
37
|
var levelMap = {
|
|
7
38
|
h900: 'h1',
|
|
8
39
|
h800: 'h1',
|
|
@@ -15,86 +46,18 @@ var levelMap = {
|
|
|
15
46
|
h200: 'div',
|
|
16
47
|
h100: 'div'
|
|
17
48
|
};
|
|
18
|
-
var headingResetStyles =
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
var
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
var
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
letterSpacing: '-0.01em',
|
|
31
|
-
lineHeight: lh(29, 32)
|
|
32
|
-
});
|
|
33
|
-
var h700Styles = css({
|
|
34
|
-
fontSize: 24,
|
|
35
|
-
fontWeight: 500,
|
|
36
|
-
letterSpacing: '-0.01em',
|
|
37
|
-
lineHeight: lh(24, 28)
|
|
38
|
-
});
|
|
39
|
-
var h600Styles = css({
|
|
40
|
-
fontSize: 20,
|
|
41
|
-
fontWeight: 500,
|
|
42
|
-
letterSpacing: '-0.008em',
|
|
43
|
-
lineHeight: lh(20, 24)
|
|
44
|
-
});
|
|
45
|
-
var h500Styles = css({
|
|
46
|
-
fontSize: 16,
|
|
47
|
-
fontWeight: 600,
|
|
48
|
-
letterSpacing: '-0.006em',
|
|
49
|
-
lineHeight: lh(16, 20)
|
|
50
|
-
});
|
|
51
|
-
var h400Styles = css({
|
|
52
|
-
fontSize: 14,
|
|
53
|
-
fontWeight: 600,
|
|
54
|
-
letterSpacing: '-0.003em',
|
|
55
|
-
lineHeight: lh(14, 16)
|
|
56
|
-
});
|
|
57
|
-
var h300Styles = css({
|
|
58
|
-
fontSize: 12,
|
|
59
|
-
fontWeight: 600,
|
|
60
|
-
letterSpacing: 0,
|
|
61
|
-
lineHeight: lh(12, 16),
|
|
62
|
-
textTransform: 'uppercase'
|
|
63
|
-
});
|
|
64
|
-
var h200Styles = css({
|
|
65
|
-
fontSize: 12,
|
|
66
|
-
fontWeight: 600,
|
|
67
|
-
letterSpacing: 0,
|
|
68
|
-
lineHeight: lh(12, 16)
|
|
69
|
-
});
|
|
70
|
-
var h100Styles = css({
|
|
71
|
-
fontSize: 11,
|
|
72
|
-
fontWeight: 700,
|
|
73
|
-
letterSpacing: 0,
|
|
74
|
-
lineHeight: lh(11, 16)
|
|
75
|
-
});
|
|
76
|
-
var styleMap = {
|
|
77
|
-
h900: h900Styles,
|
|
78
|
-
h800: h800Styles,
|
|
79
|
-
h700: h700Styles,
|
|
80
|
-
h600: h600Styles,
|
|
81
|
-
h500: h500Styles,
|
|
82
|
-
h400: h400Styles,
|
|
83
|
-
h300: h300Styles,
|
|
84
|
-
h200: h200Styles,
|
|
85
|
-
h100: h100Styles
|
|
86
|
-
};
|
|
87
|
-
var colorStyleMap = {
|
|
88
|
-
default: css({
|
|
89
|
-
color: "var(--ds-text, ".concat(N800, ")")
|
|
90
|
-
}),
|
|
91
|
-
inverse: css({
|
|
92
|
-
color: "var(--ds-text-inverse, ".concat(N0, ")")
|
|
93
|
-
}),
|
|
94
|
-
subtlest: css({
|
|
95
|
-
color: "var(--ds-text-subtlest, ".concat(N200, ")")
|
|
96
|
-
})
|
|
97
|
-
};
|
|
49
|
+
var headingResetStyles = null;
|
|
50
|
+
var h900Styles = null;
|
|
51
|
+
var h800Styles = null;
|
|
52
|
+
var h700Styles = null;
|
|
53
|
+
var h600Styles = null;
|
|
54
|
+
var h500Styles = null;
|
|
55
|
+
var h400Styles = null;
|
|
56
|
+
var h300Styles = null;
|
|
57
|
+
var h200Styles = null;
|
|
58
|
+
var h100Styles = null;
|
|
59
|
+
var inverseStyles = null;
|
|
60
|
+
var subtlestStyles = null;
|
|
98
61
|
/**
|
|
99
62
|
* __Heading__
|
|
100
63
|
*
|
|
@@ -124,13 +87,23 @@ var Heading = function Heading(_ref) {
|
|
|
124
87
|
throw new Error('`as` prop should be a string.');
|
|
125
88
|
}
|
|
126
89
|
|
|
127
|
-
var
|
|
90
|
+
var hLevel = useHeadingElement();
|
|
91
|
+
/**
|
|
92
|
+
* Order here is important, we for now apply
|
|
93
|
+
* 1. user choice
|
|
94
|
+
* 2. inferred a11y level
|
|
95
|
+
* 3. default final fallback
|
|
96
|
+
*/
|
|
97
|
+
|
|
98
|
+
var Markup = as || hLevel && "h".concat(hLevel) || levelMap[level];
|
|
128
99
|
var isSubtleHeading = level === 'h200' || level === 'h100';
|
|
129
|
-
return jsx(Markup, {
|
|
100
|
+
return jsx(CC, null, jsx(CS, null, [_, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28]), jsx(Markup, {
|
|
130
101
|
id: id,
|
|
131
|
-
"data-testid": testId
|
|
132
|
-
|
|
133
|
-
|
|
102
|
+
"data-testid": testId // @ts-ignore
|
|
103
|
+
// Resolved by https://github.com/atlassian-labs/compiled/pull/1321
|
|
104
|
+
,
|
|
105
|
+
className: ax(["_19pkyy18 _otyryy18 _syaz1fxt", level === 'h100' && "_1wyb1skh _k48p1fw0 _1dyzidpf _vwz47vkz", level === 'h200' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz", level === 'h300' && "_1wyb1crf _k48pni7l _1dyzidpf _vwz47vkz _1p1dangw", level === 'h400' && "_1wybdlk8 _k48pni7l _1dyz44hb _vwz47vkz", level === 'h500' && "_1wyb7vkz _k48pni7l _1dyzqdok _vwz4gktf", level === 'h600' && "_1wybgktf _k48pbfng _1dyzvkfx _vwz41tcg", level === 'h700' && "_1wyb1tcg _k48pbfng _1dyzz5jk _vwz41f4h", level === 'h800' && "_1wyb1pa9 _k48pni7l _1dyzz5jk _vwz4zwfg", level === 'h900' && "_1wybldb6 _k48pbfng _1dyzz5jk _vwz41ylp", color === 'inverse' && "_syaz15cr", color === 'default' && isSubtleHeading && "_syaz1wmz"])
|
|
106
|
+
}, children));
|
|
134
107
|
};
|
|
135
108
|
|
|
136
109
|
export default Heading;
|
package/dist/esm/index.js
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
export { default } from './heading';
|
|
1
|
+
export { default } from './heading';
|
|
2
|
+
export { default as HeadingContextProvider } from './heading-context';
|
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { FC } from 'react';
|
|
2
|
+
declare type HeadingElement = 1 | 2 | 3 | 4 | 5 | 6;
|
|
3
|
+
export declare const useHeadingElement: () => HeadingElement;
|
|
4
|
+
export interface HeadingContextProps {
|
|
5
|
+
/**
|
|
6
|
+
* Optional - only apply this value if the intent is to reset the heading context outside the normal content flow, for example inside a `section`.
|
|
7
|
+
*/
|
|
8
|
+
value?: HeadingElement;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* __Heading context__
|
|
12
|
+
*
|
|
13
|
+
* The HeadingContext
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```tsx
|
|
17
|
+
* // Will correctly infer the heading level
|
|
18
|
+
* <HeadingContext value={1}>
|
|
19
|
+
* <Heading>H1</Heading>
|
|
20
|
+
* <HeadingContext>
|
|
21
|
+
* <Heading>H2</Heading>
|
|
22
|
+
* </HeadingContext>
|
|
23
|
+
* </HeadingContext>
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
declare const HeadingContextProvider: FC<HeadingContextProps>;
|
|
27
|
+
export default HeadingContextProvider;
|
package/dist/types/index.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/heading",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "A heading is a typography component used to display text in different sizes and formats.",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"registry": "https://registry.npmjs.org/"
|
|
9
9
|
},
|
|
10
10
|
"atlassian": {
|
|
11
|
+
"disableProductCI": true,
|
|
11
12
|
"team": "Design System Team",
|
|
12
13
|
"releaseModel": "continuous",
|
|
13
14
|
"website": {
|
|
@@ -20,30 +21,23 @@
|
|
|
20
21
|
"module": "dist/esm/index.js",
|
|
21
22
|
"module:es2019": "dist/es2019/index.js",
|
|
22
23
|
"types": "dist/types/index.d.ts",
|
|
23
|
-
"typesVersions": {
|
|
24
|
-
">=4.0 <4.5": {
|
|
25
|
-
"*": [
|
|
26
|
-
"dist/types-ts4.0/*"
|
|
27
|
-
]
|
|
28
|
-
}
|
|
29
|
-
},
|
|
30
24
|
"sideEffects": false,
|
|
31
25
|
"atlaskit:src": "src/index.tsx",
|
|
32
26
|
"af:exports": {
|
|
33
27
|
".": "./src/index.tsx"
|
|
34
28
|
},
|
|
35
29
|
"dependencies": {
|
|
36
|
-
"@atlaskit/theme": "^12.2.0",
|
|
37
30
|
"@atlaskit/tokens": "^0.10.0",
|
|
38
31
|
"@babel/runtime": "^7.0.0",
|
|
39
|
-
"@
|
|
32
|
+
"@compiled/react": "^0.11.1"
|
|
40
33
|
},
|
|
41
34
|
"peerDependencies": {
|
|
42
|
-
"react": "^16.8.0"
|
|
35
|
+
"react": "^16.8.0 || ^17.0.0 || ^18.0.0"
|
|
43
36
|
},
|
|
44
37
|
"devDependencies": {
|
|
45
|
-
"@atlaskit/button": "^16.
|
|
38
|
+
"@atlaskit/button": "^16.4.0",
|
|
46
39
|
"@atlaskit/docs": "*",
|
|
40
|
+
"@atlaskit/ds-explorations": "*",
|
|
47
41
|
"@atlaskit/ds-lib": "^2.0.1",
|
|
48
42
|
"@atlaskit/ssr": "*",
|
|
49
43
|
"@atlaskit/visual-regression": "*",
|
|
@@ -63,11 +57,11 @@
|
|
|
63
57
|
"dom-events": "use-bind-event-listener",
|
|
64
58
|
"design-system": "v1",
|
|
65
59
|
"styling": [
|
|
66
|
-
"static"
|
|
67
|
-
"emotion"
|
|
60
|
+
"static"
|
|
68
61
|
],
|
|
69
62
|
"ui-components": "lite-mode",
|
|
70
63
|
"analytics": "analytics-next",
|
|
64
|
+
"design-tokens": "spacing",
|
|
71
65
|
"theming": "tokens",
|
|
72
66
|
"deprecation": "no-deprecated-imports"
|
|
73
67
|
}
|
package/report.api.md
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
|
+
<!-- API Report Version: 2.3 -->
|
|
2
|
+
|
|
1
3
|
## API Report File for "@atlaskit/heading"
|
|
2
4
|
|
|
3
|
-
> Do not edit this file.
|
|
5
|
+
> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
|
|
6
|
+
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
7
|
+
|
|
8
|
+
### Table of contents
|
|
9
|
+
|
|
10
|
+
- [Main Entry Types](#main-entry-types)
|
|
4
11
|
|
|
5
|
-
|
|
6
|
-
Generated API Report version: 2.0
|
|
7
|
-
-->
|
|
12
|
+
### Main Entry Types
|
|
8
13
|
|
|
9
|
-
|
|
14
|
+
<!--SECTION START: Main Entry Types-->
|
|
10
15
|
|
|
11
16
|
```ts
|
|
12
17
|
import { FC } from 'react';
|
|
@@ -16,24 +21,37 @@ import { ReactNode } from 'react';
|
|
|
16
21
|
const Heading: FC<HeadingProps>;
|
|
17
22
|
export default Heading;
|
|
18
23
|
|
|
24
|
+
// @public (undocumented)
|
|
25
|
+
interface HeadingContextProps {
|
|
26
|
+
value?: HeadingElement;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
// @public
|
|
30
|
+
export const HeadingContextProvider: FC<HeadingContextProps>;
|
|
31
|
+
|
|
32
|
+
// @public (undocumented)
|
|
33
|
+
type HeadingElement = 1 | 2 | 3 | 4 | 5 | 6;
|
|
34
|
+
|
|
19
35
|
// @public (undocumented)
|
|
20
36
|
export type HeadingProps = {
|
|
21
37
|
testId?: string;
|
|
22
38
|
children: ReactNode;
|
|
23
39
|
level:
|
|
24
|
-
| '
|
|
25
|
-
| 'h800'
|
|
26
|
-
| 'h700'
|
|
27
|
-
| 'h600'
|
|
28
|
-
| 'h500'
|
|
29
|
-
| 'h400'
|
|
30
|
-
| 'h300'
|
|
40
|
+
| 'h100'
|
|
31
41
|
| 'h200'
|
|
32
|
-
| '
|
|
42
|
+
| 'h300'
|
|
43
|
+
| 'h400'
|
|
44
|
+
| 'h500'
|
|
45
|
+
| 'h600'
|
|
46
|
+
| 'h700'
|
|
47
|
+
| 'h800'
|
|
48
|
+
| 'h900';
|
|
33
49
|
id?: string;
|
|
34
|
-
as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | '
|
|
35
|
-
color?: '
|
|
50
|
+
as?: 'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span';
|
|
51
|
+
color?: 'default' | 'inverse';
|
|
36
52
|
};
|
|
37
53
|
|
|
38
54
|
// (No @packageDocumentation comment for this package)
|
|
39
55
|
```
|
|
56
|
+
|
|
57
|
+
<!--SECTION END: Main Entry Types-->
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/heading"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { FC } from 'react';
|
|
8
|
+
import { ReactNode } from 'react';
|
|
9
|
+
|
|
10
|
+
// @public
|
|
11
|
+
const Heading: FC<HeadingProps>;
|
|
12
|
+
export default Heading;
|
|
13
|
+
|
|
14
|
+
// @public (undocumented)
|
|
15
|
+
interface HeadingContextProps {
|
|
16
|
+
value?: HeadingElement;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// @public
|
|
20
|
+
export const HeadingContextProvider: FC<HeadingContextProps>;
|
|
21
|
+
|
|
22
|
+
// @public (undocumented)
|
|
23
|
+
type HeadingElement = 1 | 2 | 3 | 4 | 5 | 6;
|
|
24
|
+
|
|
25
|
+
// @public (undocumented)
|
|
26
|
+
export type HeadingProps = {
|
|
27
|
+
testId?: string;
|
|
28
|
+
children: ReactNode;
|
|
29
|
+
level: 'h100' | 'h200' | 'h300' | 'h400' | 'h500' | 'h600' | 'h700' | 'h800' | 'h900';
|
|
30
|
+
id?: string;
|
|
31
|
+
as?: 'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span';
|
|
32
|
+
color?: 'default' | 'inverse';
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
// (No @packageDocumentation comment for this package)
|
|
36
|
+
|
|
37
|
+
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
/** @jsx jsx */
|
|
2
|
-
import { FC } from 'react';
|
|
3
|
-
import type { HeadingProps } from './types';
|
|
4
|
-
/**
|
|
5
|
-
* __Heading__
|
|
6
|
-
*
|
|
7
|
-
* A heading is a typography component used to display text in different sizes and formats.
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
*
|
|
11
|
-
* ```jsx
|
|
12
|
-
* import Heading from '@atlaskit/heading';
|
|
13
|
-
*
|
|
14
|
-
* const H100 = () => (
|
|
15
|
-
* <Heading level="h100">h100</Heading>
|
|
16
|
-
* );
|
|
17
|
-
* ```
|
|
18
|
-
*/
|
|
19
|
-
declare const Heading: FC<HeadingProps>;
|
|
20
|
-
export default Heading;
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { ReactNode } from 'react';
|
|
2
|
-
export declare type HeadingProps = {
|
|
3
|
-
/**
|
|
4
|
-
* A `testId` prop is provided for specified elements, which is a unique
|
|
5
|
-
* string that appears as a data attribute `data-testid` in the rendered code,
|
|
6
|
-
* serving as a hook for automated tests
|
|
7
|
-
*/
|
|
8
|
-
testId?: string;
|
|
9
|
-
/**
|
|
10
|
-
* The text of the heading
|
|
11
|
-
*/
|
|
12
|
-
children: ReactNode;
|
|
13
|
-
/**
|
|
14
|
-
* The headling level as defined by by the ADG
|
|
15
|
-
*/
|
|
16
|
-
level: 'h900' | 'h800' | 'h700' | 'h600' | 'h500' | 'h400' | 'h300' | 'h200' | 'h100';
|
|
17
|
-
id?: string;
|
|
18
|
-
/**
|
|
19
|
-
* Allows the component to be rendered as the specified DOM Element
|
|
20
|
-
*/
|
|
21
|
-
as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
|
|
22
|
-
/**
|
|
23
|
-
* Text color of the heading.
|
|
24
|
-
*/
|
|
25
|
-
color?: 'inverse' | 'default';
|
|
26
|
-
};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const lh: (sizePx: number, lineHeightPx: number) => number;
|