@atlaskit/page
Advanced tools
Comparing version 12.3.6 to 12.3.7
# @atlaskit/page | ||
## 12.3.7 | ||
### Patch Changes | ||
- [#83116](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83116) [`8d4e99057fe0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8d4e99057fe0) - Upgrade Typescript from `4.9.5` to `5.4.2` | ||
## 12.3.6 | ||
@@ -7,3 +13,3 @@ | ||
- [`ff79902b24c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ff79902b24c) - This package is now onboarded onto the product push model. | ||
- [#40040](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/40040) [`ff79902b24c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ff79902b24c) - This package is now onboarded onto the product push model. | ||
@@ -14,3 +20,3 @@ ## 12.3.5 | ||
- [`4ae083a7e66`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ae083a7e66) - Use `@af/accessibility-testing` for default jest-axe config and jest-axe import in accessibility testing. | ||
- [#36754](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/36754) [`4ae083a7e66`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ae083a7e66) - Use `@af/accessibility-testing` for default jest-axe config and jest-axe import in accessibility testing. | ||
@@ -21,3 +27,3 @@ ## 12.3.4 | ||
- [`e7ea6832ad2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e7ea6832ad2) - Bans the use of React.FC/React.FunctionComponent type in ADS components as part of the React 18 migration work. The change is internal only and should not introduce any changes for the component consumers. | ||
- [#33652](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/33652) [`e7ea6832ad2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e7ea6832ad2) - Bans the use of React.FC/React.FunctionComponent type in ADS components as part of the React 18 migration work. The change is internal only and should not introduce any changes for the component consumers. | ||
@@ -28,3 +34,3 @@ ## 12.3.3 | ||
- [`b1bdec7cce2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b1bdec7cce2) - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change. | ||
- [#32935](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/32935) [`b1bdec7cce2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b1bdec7cce2) - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change. | ||
@@ -35,3 +41,3 @@ ## 12.3.2 | ||
- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8 | ||
- [#33793](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/33793) [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8 | ||
@@ -42,3 +48,3 @@ ## 12.3.1 | ||
- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5` | ||
- [#33649](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/33649) [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5` | ||
@@ -49,3 +55,3 @@ ## 12.3.0 | ||
- [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump | ||
- [#33258](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/33258) [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump | ||
@@ -56,3 +62,3 @@ ## 12.2.4 | ||
- [`261420360ec`](https://bitbucket.org/atlassian/atlassian-frontend/commits/261420360ec) - Upgrades component types to support React 18. | ||
- [#31206](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/31206) [`261420360ec`](https://bitbucket.org/atlassian/atlassian-frontend/commits/261420360ec) - Upgrades component types to support React 18. | ||
@@ -63,3 +69,3 @@ ## 12.2.3 | ||
- [`4ee60bafc6d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ee60bafc6d) - ED-16603: Remove tooltips from VR tests and make them opt in. To opt-in, add `allowedSideEffects` when loading the page. | ||
- [#29227](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/29227) [`4ee60bafc6d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ee60bafc6d) - ED-16603: Remove tooltips from VR tests and make them opt in. To opt-in, add `allowedSideEffects` when loading the page. | ||
@@ -70,3 +76,3 @@ ## 12.2.2 | ||
- [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components. | ||
- [#26303](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/26303) [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components. | ||
@@ -77,3 +83,3 @@ ## 12.2.1 | ||
- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5` | ||
- [#24874](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/24874) [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5` | ||
@@ -84,3 +90,3 @@ ## 12.2.0 | ||
- [`eaa7163c94a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eaa7163c94a) - Updates `@emotion/core` to `@emotion/react`; v10 to v11. There is no expected behavior change. | ||
- [#24004](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/24004) [`eaa7163c94a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eaa7163c94a) - Updates `@emotion/core` to `@emotion/react`; v10 to v11. There is no expected behavior change. | ||
@@ -91,3 +97,3 @@ ## 12.1.4 | ||
- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`. | ||
- [#24492](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/24492) [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`. | ||
@@ -98,3 +104,3 @@ ## 12.1.3 | ||
- [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4 | ||
- [#20650](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/20650) [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4 | ||
@@ -105,3 +111,3 @@ ## 12.1.2 | ||
- [`b3ea181f8ed`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b3ea181f8ed) - Regressions in version `12.1.0` have been fixed: | ||
- [#18619](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/18619) [`b3ea181f8ed`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b3ea181f8ed) - Regressions in version `12.1.0` have been fixed: | ||
@@ -117,3 +123,3 @@ - Move to CSS `gap` has been reverted, as some use cases were not properly handled. | ||
- [`58884c2f6c1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/58884c2f6c1) - Internal code change turning on a new linting rule. | ||
- [#16752](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/16752) [`58884c2f6c1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/58884c2f6c1) - Internal code change turning on a new linting rule. | ||
@@ -124,3 +130,3 @@ ## 12.1.0 | ||
- [`4e587fa832b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e587fa832b) - [ux] The grid now uses CSS `gap` instead of margins. | ||
- [#17103](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/17103) [`4e587fa832b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e587fa832b) - [ux] The grid now uses CSS `gap` instead of margins. | ||
@@ -133,3 +139,3 @@ This package has now been migrated from `styled-components` to `@emotion/core`. As part of this change theming has been removed from `Grid`. Spacing and columns can now be set directly on the `Grid` component rather than via the `theme` prop. | ||
- [`cd34d8ca8ea`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cd34d8ca8ea) - Internal wiring up to the tokens techstack, no code changes. | ||
- [#13302](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/13302) [`cd34d8ca8ea`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cd34d8ca8ea) - Internal wiring up to the tokens techstack, no code changes. | ||
@@ -140,3 +146,3 @@ ## 12.0.6 | ||
- [`79c23df6340`](https://bitbucket.org/atlassian/atlassian-frontend/commits/79c23df6340) - Use injected package name and version for analytics instead of version.json. | ||
- [#8644](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/8644) [`79c23df6340`](https://bitbucket.org/atlassian/atlassian-frontend/commits/79c23df6340) - Use injected package name and version for analytics instead of version.json. | ||
@@ -147,3 +153,3 @@ ## 12.0.5 | ||
- [`b30ac8f0656`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b30ac8f0656) - Removes an extraneous development dependency | ||
- [#7762](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/7762) [`b30ac8f0656`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b30ac8f0656) - Removes an extraneous development dependency | ||
@@ -154,3 +160,3 @@ ## 12.0.4 | ||
- [`8047104b93`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8047104b93) - Remove invalid `spacing` attribute in rendered HTML by not passing unused spacing prop to internal Grid component. | ||
- [#6930](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/6930) [`8047104b93`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8047104b93) - Remove invalid `spacing` attribute in rendered HTML by not passing unused spacing prop to internal Grid component. | ||
@@ -161,3 +167,3 @@ ## 12.0.3 | ||
- [`d3265f19be`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d3265f19be) - Transpile packages using babel rather than tsc | ||
- [#5857](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/5857) [`d3265f19be`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d3265f19be) - Transpile packages using babel rather than tsc | ||
@@ -168,3 +174,3 @@ ## 12.0.2 | ||
- [`5f58283e1f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5f58283e1f) - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option. | ||
- [#5497](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/5497) [`5f58283e1f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5f58283e1f) - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option. | ||
This requires version 3.8 of Typescript, read more about how we handle Typescript versions here: https://atlaskit.atlassian.com/get-started | ||
@@ -177,3 +183,3 @@ Also add `typescript` to `devDependencies` to denote version that the package was built with. | ||
- [`6c525a8229`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6c525a8229) - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0 | ||
- [#3885](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/3885) [`6c525a8229`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6c525a8229) - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0 | ||
@@ -187,3 +193,3 @@ Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade | ||
- [`87f4720f27`](https://bitbucket.org/atlassian/atlassian-frontend/commits/87f4720f27) - Officially dropping IE11 support, from this version onwards there are no warranties of the package working in IE11. | ||
- [#3335](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/3335) [`87f4720f27`](https://bitbucket.org/atlassian/atlassian-frontend/commits/87f4720f27) - Officially dropping IE11 support, from this version onwards there are no warranties of the package working in IE11. | ||
For more information see: https://community.developer.atlassian.com/t/atlaskit-to-drop-support-for-internet-explorer-11-from-1st-july-2020/39534 | ||
@@ -195,3 +201,3 @@ | ||
- [`54a9514fcf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/54a9514fcf) - Build and supporting files will no longer be published to npm | ||
- [#2866](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/2866) [`54a9514fcf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/54a9514fcf) - Build and supporting files will no longer be published to npm | ||
@@ -198,0 +204,0 @@ ## 11.0.13 |
@@ -7,9 +7,6 @@ "use strict"; | ||
exports.varGridSpacing = exports.varColumnsNum = exports.varColumnSpan = exports.spacingMapping = exports.defaultSpacing = exports.defaultMedium = exports.defaultLayout = exports.defaultGridSize = exports.defaultGridColumns = exports.defaultGridColumnWidth = exports.defaultBannerHeight = void 0; | ||
var defaultGridSize = 8; | ||
exports.defaultGridSize = defaultGridSize; | ||
var defaultGridColumns = 12; | ||
exports.defaultGridColumns = defaultGridColumns; | ||
var defaultGridColumnWidth = defaultGridSize * 10; | ||
exports.defaultGridColumnWidth = defaultGridColumnWidth; | ||
var spacingMapping = { | ||
var defaultGridSize = exports.defaultGridSize = 8; | ||
var defaultGridColumns = exports.defaultGridColumns = 12; | ||
var defaultGridColumnWidth = exports.defaultGridColumnWidth = defaultGridSize * 10; | ||
var spacingMapping = exports.spacingMapping = { | ||
comfortable: defaultGridSize * 5, | ||
@@ -19,12 +16,8 @@ cosy: defaultGridSize * 2, | ||
}; | ||
exports.spacingMapping = spacingMapping; | ||
var defaultSpacing = 'cosy'; | ||
exports.defaultSpacing = defaultSpacing; | ||
var defaultBannerHeight = 52; | ||
var defaultSpacing = exports.defaultSpacing = 'cosy'; | ||
var defaultBannerHeight = exports.defaultBannerHeight = 52; | ||
// Corresponds to an `auto` width/flex-basis | ||
exports.defaultBannerHeight = defaultBannerHeight; | ||
var defaultMedium = 0; | ||
exports.defaultMedium = defaultMedium; | ||
var defaultLayout = 'fixed'; | ||
var defaultMedium = exports.defaultMedium = 0; | ||
var defaultLayout = exports.defaultLayout = 'fixed'; | ||
@@ -34,4 +27,3 @@ /** | ||
*/ | ||
exports.defaultLayout = defaultLayout; | ||
var varColumnsNum = '--ds-columns-num'; | ||
var varColumnsNum = exports.varColumnsNum = '--ds-columns-num'; | ||
@@ -41,4 +33,3 @@ /** | ||
*/ | ||
exports.varColumnsNum = varColumnsNum; | ||
var varColumnSpan = '--ds-column-span'; | ||
var varColumnSpan = exports.varColumnSpan = '--ds-column-span'; | ||
@@ -48,4 +39,2 @@ /** | ||
*/ | ||
exports.varColumnSpan = varColumnSpan; | ||
var varGridSpacing = '--ds-grid-spacing'; | ||
exports.varGridSpacing = varGridSpacing; | ||
var varGridSpacing = exports.varGridSpacing = '--ds-grid-spacing'; |
@@ -65,3 +65,3 @@ "use strict"; | ||
*/ | ||
var GridColumnContext = /*#__PURE__*/(0, _react.createContext)({ | ||
var GridColumnContext = exports.GridColumnContext = /*#__PURE__*/(0, _react.createContext)({ | ||
medium: _constants.defaultMedium | ||
@@ -77,3 +77,2 @@ }); | ||
*/ | ||
exports.GridColumnContext = GridColumnContext; | ||
var GridColumn = function GridColumn(_ref2) { | ||
@@ -113,3 +112,2 @@ var _ref2$medium = _ref2.medium, | ||
}; | ||
var _default = GridColumn; | ||
exports.default = _default; | ||
var _default = exports.default = GridColumn; |
@@ -17,3 +17,3 @@ "use strict"; | ||
*/ | ||
var GridContext = /*#__PURE__*/(0, _react.createContext)({ | ||
var GridContext = exports.GridContext = /*#__PURE__*/(0, _react.createContext)({ | ||
isRoot: true, | ||
@@ -23,3 +23,2 @@ isNested: false, | ||
columns: _constants.defaultGridColumns | ||
}); | ||
exports.GridContext = GridContext; | ||
}); |
@@ -13,4 +13,4 @@ "use strict"; | ||
var _gridContext = require("./grid-context"); | ||
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); } | ||
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; } | ||
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); } | ||
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; } | ||
/** | ||
@@ -67,3 +67,2 @@ * __Grid__ | ||
}; | ||
var _default = GridWrapper; | ||
exports.default = _default; | ||
var _default = exports.default = GridWrapper; |
@@ -47,3 +47,3 @@ "use strict"; | ||
*/ | ||
var Grid = function Grid(_ref) { | ||
var Grid = exports.Grid = function Grid(_ref) { | ||
var _ref2; | ||
@@ -63,3 +63,2 @@ var _ref$layout = _ref.layout, | ||
}, children); | ||
}; | ||
exports.Grid = Grid; | ||
}; |
@@ -25,3 +25,2 @@ "use strict"; | ||
// eslint-disable-next-line @repo/internal/react/require-jsdoc | ||
var _default = _page.default; | ||
exports.default = _default; | ||
var _default = exports.default = _page.default; |
@@ -82,3 +82,2 @@ "use strict"; | ||
}; | ||
var _default = Page; | ||
exports.default = _default; | ||
var _default = exports.default = Page; |
@@ -13,5 +13,5 @@ import type { ReactNode } from 'react'; | ||
/** | ||
Controls whether the grid should use a fixed-width layout or expand to fill available space. | ||
Defaults to `"fixed"`. | ||
* Controls whether the grid should use a fixed-width layout or expand to fill available space. | ||
* | ||
* Defaults to `"fixed"`. | ||
*/ | ||
@@ -33,6 +33,6 @@ layout?: GridLayout; | ||
/** | ||
The amount of space between each grid column. | ||
`comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
Defaults to `"cosy"`. | ||
* The amount of space between each grid column. | ||
* `comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
* | ||
* Defaults to `"cosy"`. | ||
*/ | ||
@@ -52,12 +52,12 @@ spacing: GridSpacing; | ||
/** | ||
The amount of space between each grid column. | ||
`comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
Defaults to `"cosy"`. | ||
* The amount of space between each grid column. | ||
* `comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
* | ||
* Defaults to `"cosy"`. | ||
*/ | ||
spacing?: GridSpacing; | ||
/** | ||
The total number of columns available in each row of the grid. | ||
Defaults to `12`. | ||
* The total number of columns available in each row of the grid. | ||
* | ||
* Defaults to `12`. | ||
*/ | ||
@@ -72,5 +72,5 @@ columns?: number; | ||
/** | ||
The number of columns in its parent `Grid` that the `GridColumn` should span. | ||
Defaults to `12`. | ||
* The number of columns in its parent `Grid` that the `GridColumn` should span. | ||
* | ||
* Defaults to `12`. | ||
*/ | ||
@@ -90,42 +90,42 @@ medium?: number; | ||
/** | ||
If you provide the banner or banners you are to use, page will help you | ||
coordinate the showing and hiding of them in conjunction with `isBannerOpen`. | ||
This is designed to take [banner](components/banner/) component, and | ||
matches its animation timing. | ||
The only time that two banners should be rendered are when an announcement | ||
banner is loaded alongside an error or warning banner. | ||
* If you provide the banner or banners you are to use, page will help you | ||
* coordinate the showing and hiding of them in conjunction with `isBannerOpen`. | ||
* This is designed to take [banner](components/banner/) component, and | ||
* matches its animation timing. | ||
* | ||
* The only time that two banners should be rendered are when an announcement | ||
* banner is loaded alongside an error or warning banner. | ||
*/ | ||
banner?: ReactNode; | ||
/** | ||
Takes [side navigation component](/components/side-navigation/) and helps | ||
position it with consideration to rendered banners. | ||
* Takes [side navigation component](/components/side-navigation/) and helps | ||
* position it with consideration to rendered banners. | ||
*/ | ||
navigation?: ReactNode; | ||
/** | ||
The contents of the page, to be rendered next to navigation. It will be | ||
correctly position with relation to both any banner, as well as navigation. | ||
* The contents of the page, to be rendered next to navigation. It will be | ||
* correctly position with relation to both any banner, as well as navigation. | ||
*/ | ||
children?: ReactNode; | ||
/** | ||
Sets whether to show or hide the banner. This is responsible for moving the | ||
page contents down, as well as whether to render the banner component. | ||
Defaults to `false`. | ||
* Sets whether to show or hide the banner. This is responsible for moving the | ||
* page contents down, as well as whether to render the banner component. | ||
* | ||
* Defaults to `false`. | ||
*/ | ||
isBannerOpen?: boolean; | ||
/** | ||
52 is line height (20) + 4*grid. This is the height of all banners aside | ||
from the dynamically heighted announcement banner. | ||
Banner height can be retrieved from banner using its `innerRef`, which always | ||
returns its height when expanded even when it's collapsed. | ||
In addition to setting the height of the banner's container for dynamically | ||
heighted banners, you will need to set the `pageOffset` in navigation. Since | ||
this is a lot to think about, [here](/components/page/examples#announcement-banners) | ||
is an example that implements displaying both an announcement banner and a | ||
warning banner on a page, while matching the height of each. | ||
Defaults to `52`. | ||
* `52` is line height `(20) + 4 * grid`. This is the height of all banners aside | ||
* from the dynamically heighted announcement banner. | ||
* | ||
* Banner height can be retrieved from banner using its `innerRef`, which always | ||
* returns its height when expanded even when it's collapsed. | ||
* | ||
* In addition to setting the height of the banner's container for dynamically | ||
* heighted banners, you will need to set the `pageOffset` in navigation. Since | ||
* this is a lot to think about, [here](/components/page/examples#announcement-banners) | ||
* is an example that implements displaying both an announcement banner and a | ||
* warning banner on a page, while matching the height of each. | ||
* | ||
* Defaults to `52`. | ||
*/ | ||
@@ -132,0 +132,0 @@ bannerHeight?: number; |
@@ -13,5 +13,5 @@ import type { ReactNode } from 'react'; | ||
/** | ||
Controls whether the grid should use a fixed-width layout or expand to fill available space. | ||
Defaults to `"fixed"`. | ||
* Controls whether the grid should use a fixed-width layout or expand to fill available space. | ||
* | ||
* Defaults to `"fixed"`. | ||
*/ | ||
@@ -33,6 +33,6 @@ layout?: GridLayout; | ||
/** | ||
The amount of space between each grid column. | ||
`comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
Defaults to `"cosy"`. | ||
* The amount of space between each grid column. | ||
* `comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
* | ||
* Defaults to `"cosy"`. | ||
*/ | ||
@@ -52,12 +52,12 @@ spacing: GridSpacing; | ||
/** | ||
The amount of space between each grid column. | ||
`comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
Defaults to `"cosy"`. | ||
* The amount of space between each grid column. | ||
* `comfortable` adds 40px of spacing, `cosy` adds 16px and `compact` creates 4px gap between columns. | ||
* | ||
* Defaults to `"cosy"`. | ||
*/ | ||
spacing?: GridSpacing; | ||
/** | ||
The total number of columns available in each row of the grid. | ||
Defaults to `12`. | ||
* The total number of columns available in each row of the grid. | ||
* | ||
* Defaults to `12`. | ||
*/ | ||
@@ -72,5 +72,5 @@ columns?: number; | ||
/** | ||
The number of columns in its parent `Grid` that the `GridColumn` should span. | ||
Defaults to `12`. | ||
* The number of columns in its parent `Grid` that the `GridColumn` should span. | ||
* | ||
* Defaults to `12`. | ||
*/ | ||
@@ -90,42 +90,42 @@ medium?: number; | ||
/** | ||
If you provide the banner or banners you are to use, page will help you | ||
coordinate the showing and hiding of them in conjunction with `isBannerOpen`. | ||
This is designed to take [banner](components/banner/) component, and | ||
matches its animation timing. | ||
The only time that two banners should be rendered are when an announcement | ||
banner is loaded alongside an error or warning banner. | ||
* If you provide the banner or banners you are to use, page will help you | ||
* coordinate the showing and hiding of them in conjunction with `isBannerOpen`. | ||
* This is designed to take [banner](components/banner/) component, and | ||
* matches its animation timing. | ||
* | ||
* The only time that two banners should be rendered are when an announcement | ||
* banner is loaded alongside an error or warning banner. | ||
*/ | ||
banner?: ReactNode; | ||
/** | ||
Takes [side navigation component](/components/side-navigation/) and helps | ||
position it with consideration to rendered banners. | ||
* Takes [side navigation component](/components/side-navigation/) and helps | ||
* position it with consideration to rendered banners. | ||
*/ | ||
navigation?: ReactNode; | ||
/** | ||
The contents of the page, to be rendered next to navigation. It will be | ||
correctly position with relation to both any banner, as well as navigation. | ||
* The contents of the page, to be rendered next to navigation. It will be | ||
* correctly position with relation to both any banner, as well as navigation. | ||
*/ | ||
children?: ReactNode; | ||
/** | ||
Sets whether to show or hide the banner. This is responsible for moving the | ||
page contents down, as well as whether to render the banner component. | ||
Defaults to `false`. | ||
* Sets whether to show or hide the banner. This is responsible for moving the | ||
* page contents down, as well as whether to render the banner component. | ||
* | ||
* Defaults to `false`. | ||
*/ | ||
isBannerOpen?: boolean; | ||
/** | ||
52 is line height (20) + 4*grid. This is the height of all banners aside | ||
from the dynamically heighted announcement banner. | ||
Banner height can be retrieved from banner using its `innerRef`, which always | ||
returns its height when expanded even when it's collapsed. | ||
In addition to setting the height of the banner's container for dynamically | ||
heighted banners, you will need to set the `pageOffset` in navigation. Since | ||
this is a lot to think about, [here](/components/page/examples#announcement-banners) | ||
is an example that implements displaying both an announcement banner and a | ||
warning banner on a page, while matching the height of each. | ||
Defaults to `52`. | ||
* `52` is line height `(20) + 4 * grid`. This is the height of all banners aside | ||
* from the dynamically heighted announcement banner. | ||
* | ||
* Banner height can be retrieved from banner using its `innerRef`, which always | ||
* returns its height when expanded even when it's collapsed. | ||
* | ||
* In addition to setting the height of the banner's container for dynamically | ||
* heighted banners, you will need to set the `pageOffset` in navigation. Since | ||
* this is a lot to think about, [here](/components/page/examples#announcement-banners) | ||
* is an example that implements displaying both an announcement banner and a | ||
* warning banner on a page, while matching the height of each. | ||
* | ||
* Defaults to `52`. | ||
*/ | ||
@@ -132,0 +132,0 @@ bannerHeight?: number; |
@@ -9,3 +9,3 @@ { | ||
"typesVersions": { | ||
">=4.5 <4.9": { | ||
">=4.5 <5.4": { | ||
"*": [ | ||
@@ -12,0 +12,0 @@ "../dist/types-ts4.5/grid-wrapper.d.ts" |
@@ -9,3 +9,3 @@ { | ||
"typesVersions": { | ||
">=4.5 <4.9": { | ||
">=4.5 <5.4": { | ||
"*": [ | ||
@@ -12,0 +12,0 @@ "../dist/types-ts4.5/grid-column.d.ts" |
{ | ||
"name": "@atlaskit/page", | ||
"version": "12.3.6", | ||
"version": "12.3.7", | ||
"description": "A page layout organizes sections on a page using a grid and grid columns.", | ||
@@ -70,3 +70,3 @@ "publishConfig": { | ||
"react-lorem-component": "^0.13.0", | ||
"typescript": "~4.9.5", | ||
"typescript": "~5.4.2", | ||
"wait-for-expect": "^1.2.0" | ||
@@ -100,2 +100,2 @@ }, | ||
"prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1" | ||
} | ||
} |
@@ -9,3 +9,3 @@ { | ||
"typesVersions": { | ||
">=4.5 <4.9": { | ||
">=4.5 <5.4": { | ||
"*": [ | ||
@@ -12,0 +12,0 @@ "../dist/types-ts4.5/page.d.ts" |
@@ -9,3 +9,3 @@ { | ||
"typesVersions": { | ||
">=4.5 <4.9": { | ||
">=4.5 <5.4": { | ||
"*": [ | ||
@@ -12,0 +12,0 @@ "../dist/types-ts4.5/types.d.ts" |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
88595
59
1600