@skyscanner/backpack-web 13.0.0 → 14.1.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.
Files changed (113) hide show
  1. package/README.md +67 -64
  2. package/bpk-animate-height/README.md +2 -4
  3. package/bpk-component-accordion/README.md +6 -8
  4. package/bpk-component-accordion/src/BpkAccordionItem.js +1 -2
  5. package/bpk-component-aria-live/README.md +2 -4
  6. package/bpk-component-autosuggest/README.md +5 -7
  7. package/bpk-component-badge/README.md +2 -4
  8. package/bpk-component-banner-alert/README.md +4 -6
  9. package/bpk-component-barchart/README.md +2 -4
  10. package/bpk-component-barchart/src/BpkBarchartBar.module.scss +4 -4
  11. package/bpk-component-barchart/src/BpkChartAxis.module.scss +2 -2
  12. package/bpk-component-barchart/src/BpkChartGridLines.module.scss +1 -1
  13. package/bpk-component-blockquote/README.md +2 -4
  14. package/bpk-component-breadcrumb/README.md +2 -4
  15. package/bpk-component-breakpoint/README.md +2 -4
  16. package/bpk-component-button/README.md +4 -6
  17. package/bpk-component-calendar/README.md +3 -5
  18. package/bpk-component-card/README.md +2 -4
  19. package/bpk-component-checkbox/README.md +2 -4
  20. package/bpk-component-checkbox/src/BpkCheckbox.js +1 -0
  21. package/bpk-component-checkbox/src/BpkCheckbox.module.scss +4 -0
  22. package/bpk-component-chip/README.md +3 -5
  23. package/bpk-component-close-button/README.md +2 -4
  24. package/bpk-component-code/README.md +3 -5
  25. package/bpk-component-content-cards/README.md +1 -3
  26. package/bpk-component-content-container/README.md +2 -4
  27. package/bpk-component-datatable/README.md +3 -5
  28. package/bpk-component-datepicker/README.md +4 -6
  29. package/bpk-component-description-list/README.md +2 -4
  30. package/bpk-component-dialog/README.md +3 -5
  31. package/bpk-component-drawer/README.md +3 -5
  32. package/bpk-component-fieldset/README.md +3 -5
  33. package/bpk-component-flare/README.md +2 -4
  34. package/bpk-component-floating-notification/README.md +2 -4
  35. package/bpk-component-form-validation/README.md +2 -4
  36. package/bpk-component-graphic-promotion/README.md +2 -4
  37. package/bpk-component-grid/README.md +2 -4
  38. package/bpk-component-grid-toggle/README.md +2 -4
  39. package/bpk-component-grid-toggle/src/BpkGridToggle.module.scss +1 -1
  40. package/bpk-component-horizontal-nav/README.md +2 -4
  41. package/bpk-component-icon/README.md +9 -11
  42. package/bpk-component-icon/lg/baggage-cabin-add.js +8 -0
  43. package/bpk-component-icon/lg/baggage-cabin-not-included.js +8 -0
  44. package/bpk-component-icon/lg/baggage-cabin.js +8 -0
  45. package/bpk-component-icon/lg/baggage-checked-add.js +8 -0
  46. package/bpk-component-icon/lg/baggage-checked-not-included.js +8 -0
  47. package/bpk-component-icon/lg/baggage-checked.js +8 -0
  48. package/bpk-component-icon/lg/baggage-generic.js +8 -0
  49. package/bpk-component-icon/sm/baggage-cabin-add.js +8 -0
  50. package/bpk-component-icon/sm/baggage-cabin-not-included.js +8 -0
  51. package/bpk-component-icon/sm/baggage-cabin.js +8 -0
  52. package/bpk-component-icon/sm/baggage-checked-add.js +8 -0
  53. package/bpk-component-icon/sm/baggage-checked-not-included.js +8 -0
  54. package/bpk-component-icon/sm/baggage-checked.js +8 -0
  55. package/bpk-component-icon/sm/baggage-generic.js +8 -0
  56. package/bpk-component-image/README.md +5 -7
  57. package/bpk-component-infinite-scroll/README.md +5 -7
  58. package/bpk-component-input/README.md +4 -6
  59. package/bpk-component-label/README.md +2 -4
  60. package/bpk-component-label/src/BpkLabel.js +9 -14
  61. package/bpk-component-label/src/BpkLabel.module.scss +4 -0
  62. package/bpk-component-link/README.md +2 -4
  63. package/bpk-component-list/README.md +2 -4
  64. package/bpk-component-loading-button/README.md +4 -6
  65. package/bpk-component-map/README.md +7 -9
  66. package/bpk-component-mobile-scroll-container/README.md +3 -5
  67. package/bpk-component-modal/README.md +4 -6
  68. package/bpk-component-navigation-bar/README.md +7 -9
  69. package/bpk-component-nudger/README.md +5 -7
  70. package/bpk-component-nudger/src/BpkNudger.module.scss +2 -1
  71. package/bpk-component-overlay/README.md +3 -5
  72. package/bpk-component-page-indicator/README.md +42 -0
  73. package/bpk-component-page-indicator/index.js +28 -0
  74. package/bpk-component-page-indicator/src/BpkPageIndicator.js +147 -0
  75. package/bpk-component-page-indicator/src/BpkPageIndicator.module.css +18 -0
  76. package/bpk-component-page-indicator/src/BpkPageIndicator.module.scss +91 -0
  77. package/bpk-component-page-indicator/src/NavButton.js +85 -0
  78. package/bpk-component-pagination/README.md +2 -4
  79. package/bpk-component-pagination/src/BpkPaginationNudger.module.scss +1 -22
  80. package/bpk-component-pagination/src/BpkPaginationPage.js +2 -1
  81. package/bpk-component-pagination/src/BpkPaginationPage.module.scss +5 -57
  82. package/bpk-component-panel/README.md +2 -4
  83. package/bpk-component-phone-input/README.md +3 -5
  84. package/bpk-component-popover/README.md +4 -6
  85. package/bpk-component-price/README.md +2 -4
  86. package/bpk-component-progress/README.md +2 -4
  87. package/bpk-component-radio/README.md +2 -4
  88. package/bpk-component-radio/src/BpkRadio.js +9 -10
  89. package/bpk-component-radio/src/BpkRadio.module.scss +4 -0
  90. package/bpk-component-rating/README.md +2 -4
  91. package/bpk-component-rtl-toggle/README.md +2 -4
  92. package/bpk-component-scrollable-calendar/README.md +3 -5
  93. package/bpk-component-section-list/README.md +2 -4
  94. package/bpk-component-select/README.md +2 -4
  95. package/bpk-component-skip-link/README.md +2 -4
  96. package/bpk-component-slider/README.md +2 -4
  97. package/bpk-component-spinner/README.md +2 -4
  98. package/bpk-component-split-input/README.md +2 -4
  99. package/bpk-component-star-rating/README.md +2 -4
  100. package/bpk-component-switch/README.md +2 -4
  101. package/bpk-component-table/README.md +2 -4
  102. package/bpk-component-text/README.md +5 -7
  103. package/bpk-component-textarea/README.md +2 -4
  104. package/bpk-component-theme-toggle/README.md +4 -6
  105. package/bpk-component-ticket/README.md +2 -4
  106. package/bpk-component-tooltip/README.md +3 -5
  107. package/bpk-react-utils/README.md +11 -13
  108. package/bpk-scrim-utils/README.md +2 -5
  109. package/bpk-scrim-utils/src/BpkScrim.js +1 -3
  110. package/bpk-scrim-utils/src/bpk-scrim.module.scss +3 -6
  111. package/bpk-scrim-utils/src/withScrim.js +1 -4
  112. package/bpk-theming/README.md +3 -5
  113. package/package.json +4 -4
@@ -4,15 +4,13 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-switch --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
12
  import React from 'react';
15
- import BpkSwitch from 'bpk-component-switch';
13
+ import BpkSwitch from '@skyscanner/backpack-web/bpk-component-switch';
16
14
 
17
15
  export default () => (
18
16
  <div>
@@ -4,9 +4,7 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-table --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
@@ -19,7 +17,7 @@ import {
19
17
  BpkTableRow,
20
18
  BpkTableCell,
21
19
  BpkTableHeadCell,
22
- } from 'bpk-component-table';
20
+ } from '@skyscanner/backpack-web/bpk-component-table';
23
21
 
24
22
  export default () => (
25
23
  <BpkTable>
@@ -4,15 +4,13 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-text --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```javascript
14
12
  import React from 'react';
15
- import BpkText, { TEXT_STYLES } from 'bpk-component-text';
13
+ import BpkText, { TEXT_STYLES } from '@skyscanner/backpack-web/bpk-component-text';
16
14
 
17
15
  export default () => (
18
16
  <BpkText tagName="h1" textStyle={TEXT_STYLES.subheading}>My heading</BpkText>
@@ -25,8 +23,8 @@ When using the same style in many places repeating the `textStyle` and `tagName`
25
23
 
26
24
  ```javascript
27
25
  import React from 'react';
28
- import BpkText from 'bpk-component-text';
29
- import { withDefaultProps } from 'bpk-react-utils';
26
+ import BpkText from '@skyscanner/backpack-web/bpk-component-text';
27
+ import { withDefaultProps } from '@skyscanner/backpack-web/bpk-react-utils';
30
28
 
31
29
  const LargeParagraph = withDefaultProps(BpkText, { textStyle: 'bodyLongform', tagName: 'p' });
32
30
  const TinySpan = withDefaultProps(BpkText, { textStyle: 'caption', tagName: 'span' });
@@ -56,7 +54,7 @@ Heading `textStyle` should not be confused with heading `tagName` that provide s
56
54
 
57
55
  ```javascript
58
56
  import React from 'react';
59
- import BpkText, { TEXT_STYLES } from 'bpk-component-text';
57
+ import BpkText, { TEXT_STYLES } from '@skyscanner/backpack-web/bpk-component-text';
60
58
 
61
59
  export default () => (
62
60
  <BpkText tagName="h1" textStyle={TEXT_STYLES.heading1}>My heading</BpkText>
@@ -4,15 +4,13 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-textarea --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
12
  import React from 'react';
15
- import BpkTextarea from 'bpk-component-textarea';
13
+ import BpkTextarea from '@skyscanner/backpack-web/bpk-component-textarea';
16
14
 
17
15
  export default () => (
18
16
  <BpkTextarea
@@ -4,15 +4,13 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-theme-toggle --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
12
  import React from 'react';
15
- import BpkThemeToggle from 'bpk-component-theme-toggle';
13
+ import BpkThemeToggle from '@skyscanner/backpack-web/bpk-component-theme-toggle';
16
14
 
17
15
  export default () => (
18
16
  <BpkThemeToggle />
@@ -23,8 +21,8 @@ export default () => (
23
21
 
24
22
  ```js
25
23
  import React from 'react';
26
- import { updateOnThemeChange } from 'bpk-component-theme-toggle';
27
- import BpkThemeProvider from 'bpk-theming';
24
+ import { updateOnThemeChange } from '@skyscanner/backpack-web/bpk-component-theme-toggle';
25
+ import BpkThemeProvider from '@skyscanner/backpack-web/bpk-theming';
28
26
 
29
27
  const EnhancedThemeProvider = updateOnThemeChange(BpkThemeProvider);
30
28
  ```
@@ -4,15 +4,13 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-ticket --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
12
  import React from 'react';
15
- import BpkTicket from 'bpk-component-ticket';
13
+ import BpkTicket from '@skyscanner/backpack-web/bpk-component-ticket';
16
14
 
17
15
  export default () => (
18
16
  <BpkTicket stub="Lorem ipsum dolor sit amet.">
@@ -4,16 +4,14 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-component-tooltip --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
12
  import React, { Component } from 'react';
15
- import BpkText from 'bpk-component-text';
16
- import BpkTooltip from 'bpk-component-tooltip';
13
+ import BpkText from '@skyscanner/backpack-web/bpk-component-text';
14
+ import BpkTooltip from '@skyscanner/backpack-web/bpk-component-tooltip';
17
15
 
18
16
  const App = () => (
19
17
  const targetRef = useRef(null);
@@ -4,9 +4,7 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-react-utils --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Portal.js
12
10
 
@@ -16,9 +14,9 @@ it's necessary in overcoming z-index issues when absolutely positioning elements
16
14
  ### Usage
17
15
 
18
16
  ```js
19
- import { Portal } from 'bpk-react-utils';
20
- import BpkButton from 'bpk-component-button';
21
- import { BpkCode } from 'bpk-component-code';
17
+ import { Portal } from '@skyscanner/backpack-web/bpk-react-utils';
18
+ import BpkButton from '@skyscanner/backpack-web/bpk-component-button';
19
+ import { BpkCode } from '@skyscanner/backpack-web/bpk-component-code';
22
20
  import React, { Component } from 'react';
23
21
 
24
22
  class MyComponent extends Component {
@@ -81,7 +79,7 @@ A helpful utility which permits backwards compatibility with hard coded classes
81
79
 
82
80
  ```js
83
81
  import React from 'react';
84
- import { cssModules } from 'bpk-react-utils';
82
+ import { cssModules } from '@skyscanner/backpack-web/bpk-react-utils';
85
83
 
86
84
  import STYLES from './MyComponent.scss';
87
85
 
@@ -119,7 +117,7 @@ Without CSS modules:
119
117
  The returned function accepts multiple class names and ignores values other than strings. e.g:
120
118
 
121
119
  ```js
122
- import { cssModules } from 'bpk-react-utils';
120
+ import { cssModules } from '@skyscanner/backpack-web/bpk-react-utils';
123
121
 
124
122
  import STYLES from './MyComponent.scss';
125
123
 
@@ -143,7 +141,7 @@ components initial mount. All you need to provide is two class names and a timeo
143
141
 
144
142
  ```js
145
143
  import React from 'react';
146
- import { TransitionInitialMount } from 'bpk-react-utils';
144
+ import { TransitionInitialMount } from '@skyscanner/backpack-web/bpk-react-utils';
147
145
 
148
146
  const MyComponent = (props) => (
149
147
  <TransitionInitialMount
@@ -190,7 +188,7 @@ Returns true if the browser is showing content right-to-left.
190
188
 
191
189
  ```js
192
190
  import React from 'react';
193
- import { isRTL } from 'bpk-react-utils';
191
+ import { isRTL } from '@skyscanner/backpack-web/bpk-react-utils';
194
192
 
195
193
  if (isRTL()) {
196
194
  // do RTL stuff
@@ -207,7 +205,7 @@ Returns true if the device is an iPhone.
207
205
 
208
206
  ```js
209
207
  import React from 'react';
210
- import { isDeviceIphone } from 'bpk-react-utils';
208
+ import { isDeviceIphone } from '@skyscanner/backpack-web/bpk-react-utils';
211
209
 
212
210
  if (isDeviceIphone()) {
213
211
  // do iPhone specific stuff
@@ -224,7 +222,7 @@ Returns true if the device is an iPad.
224
222
 
225
223
  ```js
226
224
  import React from 'react';
227
- import { isDeviceIpad } from 'bpk-react-utils';
225
+ import { isDeviceIpad } from '@skyscanner/backpack-web/bpk-react-utils';
228
226
 
229
227
  if (isDeviceIpad()) {
230
228
  // do iPad specific stuff
@@ -241,7 +239,7 @@ Returns true if the platform is iOS (iPhone/iPad).
241
239
 
242
240
  ```js
243
241
  import React from 'react';
244
- import { isDeviceIos } from 'bpk-react-utils';
242
+ import { isDeviceIos } from '@skyscanner/backpack-web/bpk-react-utils';
245
243
 
246
244
  if (isDeviceIos()) {
247
245
  // do iOS specific stuff
@@ -4,12 +4,10 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-scrim-utils --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ```js
12
- import { withScrim } from 'bpk-scrim-utils';
10
+ import { withScrim } from '@skyscanner/backpack-web/bpk-scrim-utils';
13
11
 
14
12
  const Box = props => (
15
13
  <div ref={props.dialogRef}>
@@ -41,7 +39,6 @@ const BoxWithScrim = withScrim(Box);
41
39
  | isIphone | bool | false | `/iPhone/i.test(typeof window !== 'undefined' ? window.navigator.platform : '')` |
42
40
  | containerClassName | string | false | '' |
43
41
  | closeOnScrimClick | bool | false | true |
44
- | dark | bool | false | false |
45
42
 
46
43
  ### Prop Details
47
44
 
@@ -33,7 +33,7 @@ const BpkScrim = (props) => (
33
33
  >
34
34
  <div
35
35
  role="presentation"
36
- className={getClassName('bpk-scrim', props.dark && 'bpk-scrim--dark')}
36
+ className={getClassName('bpk-scrim')}
37
37
  onMouseDown={props.onClose}
38
38
  onTouchStart={props.onClose}
39
39
  />
@@ -41,12 +41,10 @@ const BpkScrim = (props) => (
41
41
  );
42
42
 
43
43
  BpkScrim.propTypes = {
44
- dark: PropTypes.bool,
45
44
  onClose: PropTypes.func,
46
45
  };
47
46
 
48
47
  BpkScrim.defaultProps = {
49
- dark: false,
50
48
  onClose: null,
51
49
  };
52
50
 
@@ -26,15 +26,12 @@
26
26
  left: 0;
27
27
  z-index: $bpk-zindex-scrim;
28
28
  transition: opacity $bpk-duration-sm ease-in-out;
29
- background-color: $bpk-scrim-background-color;
29
+ background-color: $bpk-scrim-day;
30
+
31
+ // We will need to remove this on hex launch as opacity will be built into the above colour.
30
32
  opacity: $bpk-scrim-opacity;
31
33
  overflow: hidden;
32
34
 
33
- &--dark {
34
- background-color: $bpk-scrim-dark-background-color;
35
- opacity: $bpk-scrim-dark-opacity;
36
- }
37
-
38
35
  &--full-screen {
39
36
  @include bpk-breakpoint-mobile {
40
37
  opacity: $bpk-scrim-mobile-opacity;
@@ -47,7 +47,6 @@ const withScrim = (WrappedComponent) => {
47
47
  static propTypes = {
48
48
  getApplicationElement: PropTypes.func.isRequired,
49
49
  onClose: onClosePropType,
50
- dark: PropTypes.bool,
51
50
  isIphone: PropTypes.bool,
52
51
  isIpad: PropTypes.bool,
53
52
  containerClassName: PropTypes.string,
@@ -55,7 +54,6 @@ const withScrim = (WrappedComponent) => {
55
54
  };
56
55
 
57
56
  static defaultProps = {
58
- dark: false,
59
57
  onClose: null,
60
58
  isIphone: isDeviceIphone(),
61
59
  isIpad: isDeviceIpad(),
@@ -125,7 +123,6 @@ const withScrim = (WrappedComponent) => {
125
123
  const {
126
124
  closeOnScrimClick,
127
125
  containerClassName,
128
- dark,
129
126
  getApplicationElement,
130
127
  isIpad,
131
128
  isIphone,
@@ -141,7 +138,7 @@ const withScrim = (WrappedComponent) => {
141
138
 
142
139
  return (
143
140
  <div className={classNames.join(' ')}>
144
- <BpkScrim onClose={closeOnScrimClick ? onClose : null} dark={dark} />
141
+ <BpkScrim onClose={closeOnScrimClick ? onClose : null} />
145
142
  <WrappedComponent
146
143
  {...rest}
147
144
  isIphone={isIphone}
@@ -4,16 +4,14 @@
4
4
 
5
5
  ## Installation
6
6
 
7
- ```sh
8
- npm install bpk-theming --save-dev
9
- ```
7
+ Check the main [Readme](https://github.com/skyscanner/backpack#usage) for a complete installation guide.
10
8
 
11
9
  ## Usage
12
10
 
13
11
  ```js
14
- import BpkThemeProvider from 'bpk-theming';
12
+ import BpkThemeProvider from '@skyscanner/backpack-web/bpk-theming';
15
13
 
16
- import BpkLink, { themeAttributes as linkThemeAttributes } from 'bpk-component-link';
14
+ import BpkLink, { themeAttributes as linkThemeAttributes } from '@skyscanner/backpack-web/bpk-component-link';
17
15
 
18
16
  const theme = {
19
17
  linkColor: '#c00',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyscanner/backpack-web",
3
- "version": "13.0.0",
3
+ "version": "14.1.0",
4
4
  "description": "Backpack Design System web library",
5
5
  "repository": {
6
6
  "type": "git",
@@ -24,11 +24,11 @@
24
24
  "dependencies": {
25
25
  "@popperjs/core": "^2.11.5",
26
26
  "@react-google-maps/api": "^2.12.0",
27
- "@skyscanner/bpk-foundations-web": "^10.4.0",
28
- "@skyscanner/bpk-svgs": "^14.5.9",
27
+ "@skyscanner/bpk-foundations-web": "^12.1.0",
28
+ "@skyscanner/bpk-svgs": "^15.1.4",
29
29
  "a11y-focus-scope": "^1.1.3",
30
30
  "a11y-focus-store": "^1.0.0",
31
- "bpk-mixins": "^32.2.0",
31
+ "bpk-mixins": "^35.0.0",
32
32
  "d3-path": "^2.0.0",
33
33
  "d3-scale": "^4.0.2",
34
34
  "date-fns": "^2.21.1",