Releases: newscorp-ghfb/NewsKit
v6.1.0
What's Changed
New Features π
- feat(PPDSC-2115): accordion motion by @mstuartf in #264
- chore(PPDSC-2358): removed loading state for Tag and Flag components by @evgenitsn in #359
- feat(PPDSC-2396): update no pointer distance for the tooltip and popover components by @jannuk59 in #365
- feat(PPDSC-2244): create text-area component by @mutebg in #364
- docs(PPDSC-2420): introduce new homepage by @evgenitsn in #376
Bug Fixes π
- fix(PPDSC-2413): textfield and select spacing issue by @mutebg in #367
- fix(PPDSC-2312): audio player test improvements by @mstuartf in #373
Other Changes π§±
- docs(PPDSC-2394): update readme by @jps in #355
- chore(PPDSC-2379): update k8 ingress by @Vanals in #357
- docs(PPDSC-2336): chore-ppdse-2336-added NextLink added to site by @baburay23 in #356
- build(PPDSC-2404): add version back into image name for dev deploy by @jps in #361
- docs(PPDSC-2288): Flag documentation by @Srinivasan-Ramasamy in #358
- docs(PPDSC-2290): Audio player documentation by @Srinivasan-Ramasamy in #353
- chore(PPDSE-2397): chore-ppdse-2397-search-mobile-menu by @baburay23 in #362
- docs(PPDSC-2298): NewsKit homepage update - What's New section by @evgenitsn in #349
- chore(PPDSC-2280): chore-ppdse-2280-added prevent default by @baburay23 in #366
- docs(PPDSC-2289): Text block documentation by @Srinivasan-Ramasamy in #363
- feat(PPDSC-2322): add tealiumTrack to instrumentation by @Xin00163 in #352
- docs(PPNKD-554): update website copy guides section by @TomPerryUX in #372
- docs(PPDSC-2301): newskit homepage hero interactive elements by @evgenitsn in #360
New Contributors
- @TomPerryUX made their first contribution in #372
- @jannuk59 made their first contribution in #365
Full Changelog: v6.0.0...v6.1.0
v6.0.0
What's Changed
Breaking Changes π
- feat(PPDSC-2005) layer manager by @pdimova in #146
- feat(PPDSC-2214): add emotion as peer dependency by @mutebg in #293
- feat(PPDSC-1958): stop exporting emotion icons by @mutebg in #281
- feat(PPDSC-2253): storybook scenarios and UL default updates by @Vanals in #295
- chore(PPDSC-2171): add forwardRef to components part 1 by @baburay23 in #294
- chore(PPDSC-2215): add forwardRef to components part 2 by @evgenitsn in #315
New Features π
- feat(PPDSC-2242): update to React 18 by @tbradbury in #301
- feat(PPDSC-2307) switch consistency in defaults by @mutebg in #303
- feat(PPDSC-2311): temporarily skip aborted tests by @mstuartf in #311
- feat(PPDSC-2256): update drop cap logical props and presets by @evgenitsn in #312
- feat(PPDSC-2143): volume control horizontal expand by @baburay23 in #306
- feat(PPDSC-2274): vertical volume control in Popover by @mutebg in #334
- feat(PPDSC-2313): script to run Applitools locally by @mstuartf in #321
- feat(PPDSC-2315): implement Applitools spike recommendations by @mstuartf in #324
- feat(PPDSC-2314): audio player - playback speed custom children trigger by @evgenitsn in #322
- feat(PPDSC-2308): add support for additional HTML attributes by @mstuartf in #344
- feat(PPDSC-2037): add "The Times" and "The Sun" fonts && include them in theme checker by @Vanals in #332
- feat(EOP-253): add async support to experimentation web by @Georg-Mirchev in #323
- feat(PPDSC-2163): codemods for enums by @Xin00163 in #331
- chore(PPDSC-2329): codemod link component by @baburay23 in #330
- chore(PPDSC-1852): replace enums by @baburay23 in #340
Bug Fixes π
- fix(PPDSC-2241): add stylepresets to dialog header by @tbradbury in #296
- fix(PPDSC-2304): useBreakpointKey incorrect state by @evgenitsn in #325
- fix(PPDSC-2302): remove dev dependencies from
package.json
by @mutebg in #341 - fix(PPDSC-2266): remove typo in video player styling by @mstuartf in #346
Other Changes π§±
- docs(PPDSC-2268): Accordion documentation by @Srinivasan-Ramasamy in #292
- docs(PPDSC-2267): Popover documentation by @Srinivasan-Ramasamy in #305
- docs(PPDSC-2269): Tooltip documentation by @Srinivasan-Ramasamy in #313
- docs(PPDSC-2263): Switch documentation by @Srinivasan-Ramasamy in #348
- docs(PPDSC-2270): Form documentation by @Srinivasan-Ramasamy in #327
- docs(PPDSC-2287): Grid layout documentation by @Srinivasan-Ramasamy in #335
- docs(PPDSC-2291): Component defaults documentation by @Srinivasan-Ramasamy in #342
- docs(PPDSC-2303): Compliance and related sections changes by @Srinivasan-Ramasamy in #339
- docs(PPDSC-2252): Misc updates on the site by @Srinivasan-Ramasamy in #317
- docs(PPDSC-1995): Update NewsKit theme - dark & light by @evgenitsn in #345
- docs(PPDSC-2332): Search on doc site by @Xin00163 in #337
- docs(PPDSC-2259): [WIP] NewsKit new homepage - skeleton by @Xin00163 in #318
- docs(PPDSC-2299): [WIP] NewsKit new homepage - hero by @evgenitsn in #329
- docs(PPDSC-2297): [WIP] NewsKit new homepage - banners, explore and more by @evgenitsn in #336
- docs(PPDSC-2204): Release notes by @mstuartf in #319
- chore(PPDSC-2229): Update storybook container styles by @evgenitsn in #316
- docs(PPDSC-2334): Update docs by @jps in #320
- chore(PPDSC-2369) Fix DOM errors in docs website by @mutebg in #343
- chore(deps): Bump terser from 4.8.0 to 4.8.1 by @dependabot in #307
- chore(deps): Bump moment from 2.29.2 to 2.29.4 by @dependabot in #274
Full Changelog: v5.7.0...v6.0.0
New Contributors
- @Georg-Mirchev made their first contribution in #323
NewsKit v6 Migration Guide
NewsKit Provider
NewsKitProvider replaces the top-level ThemeProvider, internally this provider includes:
- ThemeProvider
- MediaQueryProvider
- InstrumentationProvider
- LayerManager
That means if your current app looks like this
<InstrumentationProvider {...instrumentation provider props..}>
<ThemeProvider theme={theme}>
<App />
</ThemeProvider />
</InstrumentationProvider>
Needs to be updated to this:
<NewsKitProvider theme={theme} instrumentation={...instrumentation provider props..}>
<App />
</NewsKitProvider>
When you create sub-themes the <ThemeProvider />
still can be nested to facilitate that.
We also introduced a new LayerManager that handles stacking context ( z-index ) depending on the way you build the custom components you might need to adjust NewsKitProvider
as passing zIndex
value so that newskit components like Modal and Drawer render above your custom components.
<NewsKitProvider layer={{zIndex: 999}}> .... </NewsKitProvider>
Emotion packages as peer dependencies
Starting from version 6, newskit does not include @emotion/styled
& @emotion/react
libraries, which means you need to install these separately:
// npm
npm install [email protected] @emotion/react @emotion/styled
// or yarn
yarn add [email protected] @emotion/react @emotion/styled
Icons
Starting from version 6, newskit does not include emotion icons, you have to install @emotion-icons/material
and @emotion-icons/material-outlined
and import them manually.
You can also search for the corresponding icon here https://emotion-icons.dev/ and follow the example below:
// Old way
import { IconFilledAccountTree } from 'newskit';
// New way
import {toNewsKitIcon} from 'newskit';
import {AccountTree} from '@emotion-icons/material/AccountTree';
const IconFilledAccountTree = toNewsKitIcon(AccountTree);
We also provide a codemod for that transformation, so you donβt have to do it manually.
npx @newskit/codemod emotion-icons 'components/**/*.+(ts|tsx|json)'
From Enum to Union Types
We removed all typescript Enum
from newskit and replaced them with Union
types.
For example:
// Old
<Button size={ButtonSize.Small}>Button</Button>
// New
<Button size="small">Button</Button>
We also provide a codemod for that transformation, so you donβt have to do it manually.
npx @newskit/codemod enum-to-union 'components/**/*.+(ts|tsx|json)'
UnorderedList has a circle icon as a marker by default
Before version 6, UnorderedList
component did not include any marker icon by default, from v6.
If you still need that behaviour you can remove the icon by passing null
to listItemMarker
prop.
For example:
<UnorderedList listItemMarker={null} />
We also provide a codemod
for that transformation, so you donβt have to do it manually.
npx @newskit/codemod update-list-item-marker-ul-value 'components/**/*.+(ts|tsx|json)'
Codemods
For most of the breaking changes, we provide codemods which would provide an easy migration to v6, checkout @newskit/codemod package at NPM for the complete list of scripts.
v5.7.0
What's Changed
New Features π
- feat(PPDSC-2151): Add Outline Style Presets by @tbradbury in #214
- feat(PPDSC-2161):
<SelectionList/>
component by @evgenitsn in #231 - feat(PPDSC-2121):
<Popover/>
header close by @mstuartf in #239 - feat(PPDSC-2182): added
initialTime
prop and test by @agagotowiec in #238 - feat(PPDSC-2151): add outline override examples by @tbradbury in #243
- feat(PPDSC-2220): improve
main
branch protection in ci by @evgenitsn in #246 - feat(PPDSC-2249): drop concurrency limit for components by @jps in #255
- feat(PPDSC-2119): floating element motion by @mstuartf in #245
- feat(PPDSC-2226): functionality to dismiss
<Popover/>
by @tbradbury in #258 - feat(PPDSC-2248):
<StructuredList/>
no icon prop when link by @evgenitsn in #261 - feat(PPDSC-2180): theme switch added to storybook by @tbradbury in #235
- feat(PPDSC-2176):
<Tooltip/>
updates by @baburay23 in #256 - feat(PPDSC-2162):
codemods
setup package by @mutebg in #222 - feat(PPDSC-2114):
<AudioPlayer/>
playback speed control by @evgenitsn in #290 - feat(PPDSC-2273): add pr and job urls to applitools batch name by @mstuartf in #291
Bug Fixes π
- fix(PPDSC-2164): assistive text by @mstuartf in #249
- fix(PPDSC-2193): added auto reverse unset to cssfunc by @khadirkilo92 in #242
- fix(PPDSC-2254): update audio file used in tests by @tbradbury in #268
- fix(PPDSC-2216): add aria-required to form-input-components by @evgenitsn in #257
- fix(PPDSC-2277): CircleCI not sending message on pipeline failures by @Vanals in #277
- fix(PPDSC-2208): svg previewer: remove sourcepoint and tealium in dev by @Vanals in #276
- feat(PPDSC-2218): added Scroll storybook scenario by @agagotowiec in #248
Other Changes π§±
- docs(PPDSC-2187): Patterns date picker and email address pages by @Srinivasan-Ramasamy in #237
- docs(PPDSC-2188): Patterns gender and names pages by @Srinivasan-Ramasamy in #241
- docs(PPDSC-2189): Patterns passwords and payment pages by @Srinivasan-Ramasamy in #244
- docs(PPDSC-2190): Patterns telephone number and input components pages by @Srinivasan-Ramasamy in #267
- docs(PPDSC-2250): Fix for broken links in site by @Srinivasan-Ramasamy in #271
- docs(PPDSC-2224): Fix for PR navigation URL by @Srinivasan-Ramasamy in #273
- chore(PPDSC-2170): Follow-up ticket for Audio Player v2 - Volume Control by @Xin00163 in #247
- ci(PPDSC-2084): Updating circleci/slack and bringing back all messages on failures by @Vanals in #250
- ci(PPDSC-2292): attempt fix of develoment env by @jps in #285
New Contributors
- @agagotowiec made their first contribution in #238
- @PanchoDaskalov made their first contribution in #260
Full Changelog: v5.6.0...v5.7.0
v5.6.0
What's Changed
New Features π
- feat(PPDSC-2120): popover v1 by @mstuartf in #228
- feat(PPDSC-2156): accordion group by @mutebg in #234
- feat(PPDSC-2152): single accordion by @Xin00163 in #224
- feat(PPDSC-2112): audio player v2 volume control by @Vanals in #208
Bug Fixes π
- fix(PPDSC-1969): fix CRA errors by @evgenitsn in #226
- fix(PPDSC-2213): Fix for featurecard banner render issue by @Srinivasan-Ramasamy in #229
- fix(PPDSC-2199): docs-ppdse-2199-drawer-correct-state by @baburay23 in #230
- fix(PPDSC-2166): website broken repo links by @evgenitsn in #232
Other Changes π§±
- Fix/ppdsc 2208 newskit not working on iframe REVERT CHANGES by @Vanals in #227
- docs/ppdse 2173 build foundation pages by @khadirkilo92 in #216
- docs(PPDSC-2191): Patterns best practice page by @Srinivasan-Ramasamy in #225
- docs(PPDSC-2186): Patterns address and dob pages by @Srinivasan-Ramasamy in #233
New Contributors
- @khadirkilo92 made their first contribution in #216
Full Changelog: v5.5.0...v5.6.0
v5.5.0
What's Changed
New Features π
- feat(PPDSC-1986): layout props 6/7 by @evgenitsn in #213
- feat(PPDSC-1985): logical props 5/6 by @mstuartf in #209
- feat(PPDSC-2175): layout props 7/7 by @evgenitsn in #223
- feat(PPDSC-2118): tooltip pointer by @mstuartf in #217
Bug Fixes π
- bugfix(PPDSC-2208): removed extra script by @Vanals in #220
- fix(PPDSC-2203): handling non text children in Paragraph by @mutebg in #221
Other Changes π§±
- docs(PPDSC-2096): Update with new tokens and states by @Srinivasan-Ramasamy in #210
- docs(PPDSC-2064): doc site nav by @baburay23 in #190
- docs(PPDSC-2172): Patterns index and overview pages by @Srinivasan-Ramasamy in #218
Full Changelog: https://github.com/newscorp-ghfb/newskit/compare/[email protected]
V5.4.6
What's Changed
New Features π
- feat(PPDSC-2067): audio player v2 live functionality stories and tests by @evgenitsn in #200
- feat(PPDSC-2095): add opacity tokens and gradients to the theme by @evgenitsn in #202
- feat(PPDSC-2123): add link to the Handoff guide for engineers to the site by @tbradbury in #203
- feat(PPDSC-1984): logical props 4 by @mstuartf in #191
- feat(PPDSC-2135): add unified script to Consent by @tbradbury in #193
- feat(PPDSC-2078): switch v1 by @mstuartf in #182
- feat(PPDSC-2117): tooltip panel and content by @Xin00163 in #204
- feat(PPDSC-2179): switch stories by @mstuartf in #212
Bug Fixes π
- Fix/ppdsc 2113 prodtealium not being served by @Vanals in #194
- fix(PPDSC-2047): Resolve gaps in buffering seekbar by refactoring formatTrackData by @tbradbury in #206
- fix(PPDSC-2198): update SSL Cert ARNs by @tbradbury in #215
Other Changes π§±
- docs(PPDSC-2138): Updated testing card by @Srinivasan-Ramasamy in #198
- docs(PPDSC-2139): remove grey background on header comp by @evgenitsn in #201
- docs(PPDSC-2082): Update contribute page by @Srinivasan-Ramasamy in #205
- docs(PPDSC-2150): Structured list page by @Srinivasan-Ramasamy in #207
Full Changelog: https://github.com/newscorp-ghfb/newskit/compare/[email protected]
V5.4.5
V5.4.4
VERSION DEPRECATED -- PLEASE USE V5.4.5 INSTEAD
What's Changed
Bug Fixes π
- fix(PPDSC-2160): Fixed pipeline error, which did not allow proper NewsKit package publishment by @Vanals in #196
Other Changes π§±
- docs(PPDSC-2149): Updated structured-list page link by @Srinivasan-Ramasamy in #195
Full Changelog: https://github.com/newscorp-ghfb/newskit/compare/[email protected]
v5.4.3
VERSION DEPRECATED -- USE 5.4.5 INSTEAD
What's Changed
New Features π
- feat(PPDSC-2054): add feedback element and transition preset to slider, checkbox & radio button by @evgenitsn in #160
- docs(PPDSC-2006): shrink all title and desc containers for docs by @evgenitsn in #148
- feat(PPDSC-1982): layout props 2 of 6 by @Xin00163 in #164
- feat(PPDSC-2072): enable applitools logs by @tbradbury in #186
- feat(PPDSC-1942): add Safari specific css to tabs by @tbradbury in #187
- feat(PPDSC-2107): add tracking support to structured list and text field by @evgenitsn in #184
- ci(PPDSC-2017): newskit integration test by @Vanals in #183
- feat(PPDSC-1983): add logical props part 3/6 by @Xin00163 in #192
Bug Fixes π
- fix(PPDSC-2134): make BaseSwitch data-testid overridable by @evgenitsn in #180
Other Changes π§±
- docs(PPDSC-2075): Button page by @Srinivasan-Ramasamy in #175
- docs(PPDSC-1976): Media list fix by @Srinivasan-Ramasamy in #179
- docs(PPDSC-2133): Fieldset by @Srinivasan-Ramasamy in #189
Full Changelog: https://github.com/newscorp-ghfb/newskit/compare/[email protected]
v5.4.2
What's Changed
New Features π
- feat(PPDSC-2007): New Release flow and Gitflow to GitHub flow by @Vanals in #126
Bug Fixes π
- fix(PPDSR-2081): fix broken link in site by @tbradbury in #158
- fix(PPDSC-2105): remove unnecessarily disabled a11y rules in cmp tests by @mstuartf in #171
- fix(PPDSC-2104): increase next version to >12.1.1 by @mstuartf in #170
- chore(PPDSC-2079): update axe-core and fix any errors by @evgenitsn in #167
- fix(PPDSC-2108): handle different browser zoom level in scroll tests by @mstuartf in #173
- fix(PPDSC-2106): correct minimum supported node version by @mstuartf in #172
Other Changes π§±
- chore(PPDSC-2007): GitFlow to GitHub Flow: Fixing version parameter drill by @Vanals in #153
- Chore/ppdsc 2007 rolling back package.json version by @Vanals in #157
- build(deps): bump moment from 2.29.1 to 2.29.2 by @dependabot in #154
- docs(PPDSC-1903): Select page by @Srinivasan-Ramasamy in #152
- docs(PPDSC-2074): Text field page by @Srinivasan-Ramasamy in #162
- Ci/ppdse 0000 fix release by @baburay23 in #176
New Contributors
- @tbradbury made their first contribution in #158
- @mstuartf made their first contribution in #171
Full Changelog: https://github.com/newscorp-ghfb/newskit/compare/[email protected]