Skip to content

Commit

Permalink
chore: Merge prerelease/minor into prerelease/major (#2880)
Browse files Browse the repository at this point in the history
Co-authored-by: @mannycarrera4 <[email protected]>
Co-authored-by: manuel.carrera <[email protected]>
Co-authored-by: @mannycarrera4 <[email protected]>
Co-authored-by: @NicholasBoll <[email protected]>
  • Loading branch information
4 people authored Aug 21, 2024
2 parents e249801 + 6f79355 commit 1e0bc45
Show file tree
Hide file tree
Showing 16 changed files with 69 additions and 35 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [v11.1.4](https://github.com/Workday/canvas-kit/releases/tag/v11.1.4) (2024-08-21)

### Documentation

- docs: Update CanvasProvider info on install page ([#2878](https://github.com/Workday/canvas-kit/pull/2878)) ([@mannycarrera4](https://github.com/mannycarrera4), manuel.carrera, [@alanbsmith](https://github.com/alanbsmith))


## [v10.3.54](https://github.com/Workday/canvas-kit/releases/tag/v10.3.54) (2024-08-21)

### Documentation

- docs: Update CanvasProvider info on install page ([#2878](https://github.com/Workday/canvas-kit/pull/2878)) ([@mannycarrera4](https://github.com/mannycarrera4), manuel.carrera, [@alanbsmith](https://github.com/alanbsmith))
## [v11.1.3](https://github.com/Workday/canvas-kit/releases/tag/v11.1.3) (2024-08-20)

### Components
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"packages": [
"modules/**"
],
"version": "11.1.3",
"version": "11.1.4",
"npmClient": "yarn",
"useWorkspaces": true,
"command": {
Expand Down
2 changes: 1 addition & 1 deletion modules/codemod/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@workday/canvas-kit-codemod",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
"version": "11.1.3",
"version": "11.1.4",
"description": "A collection of codemods for use on Workday Canvas Kit packages.",
"main": "dist/es6/index.js",
"sideEffects": false,
Expand Down
2 changes: 1 addition & 1 deletion modules/css/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-css",
"version": "11.1.3",
"version": "11.1.4",
"description": "The parent module that contains all Workday Canvas Kit CSS components",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down
42 changes: 32 additions & 10 deletions modules/docs/mdx/welcome.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,42 @@ import {version} from '../../../lerna.json';

<WelcomePage />

After installing Canvas Kit, you need to set up the CanvasProvider at the root of your application.
This can be either in your `index.jsx`,`index.tsx` or `App.jsx` depending on the framework you use.
This ensures proper styling, theming, and focus behavior on our components.
### Canvas Provider

The `<CanvasProvider>` is required for proper branding support. Furthermore, if you use Emotion for
styling your components, the `<CanvasProvider>` ensures your styles will merge as expected. Note:
Custom use of `<CacheProvider>` provided by Emotion is not supported. `@workday/canvas-kit-styling`
owns the creating of the cache reference. This ensures both static styling and Emotion’s dynamic
styling solutions work together. In most cases you'll want to wrap your application at the root
level in `<CanvasProvider>`.

```tsx
import * as React from 'react';
// 1. import `CanvasProvider` component
import {CanvasProvider} from '@workday/canvas-kit-react';
function App() {
// 2. Wrap CanvasProvider at the root of your app
import {
CanvasProvider,
ContentDirection,
PartialEmotionCanvasTheme,
useTheme,
} from '@workday/canvas-kit-react/common';
// Ensure CSS variables are defined. You Can also do this at the root index.css
import '@workday/canvas-tokens-web/css/base/_variables.css';
import '@workday/canvas-tokens-web/css/brand/_variables.css';
import '@workday/canvas-tokens-web/css/system/_variables.css';

export const App = () => {
// useTheme is filling in the Canvas theme object if any keys are missing
const canvasTheme: PartialEmotionCanvasTheme = useTheme({
canvas: {
// Switch to `ContentDirection.RTL` to change direction
direction: ContentDirection.LTR,
},
});
return (
<CanvasProvider>
<YourApp />
<CanvasProvider theme={canvasTheme}>
<main>
<p>Get Started With Canvas Kit</p>
</main>
</CanvasProvider>
);
}
};
```
2 changes: 1 addition & 1 deletion modules/docs/mdx/welcomePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {version} from '../../../lerna.json';

export const WelcomePage = () => {
return (
<Flex flexDirection="column" gap="s">
<Flex flexDirection="column" gap="s" marginBottom="m">
<Box borderRadius="m" overflow="hidden" position="relative">
<Flex position="absolute" flexDirection="column" top="30%" left="10%">
<Text
Expand Down
10 changes: 5 additions & 5 deletions modules/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-docs",
"version": "11.1.3",
"version": "11.1.4",
"description": "Documentation components of Canvas Kit components",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -44,10 +44,10 @@
"dependencies": {
"@emotion/styled": "^11.6.0",
"@storybook/csf": "0.0.1",
"@workday/canvas-kit-labs-react": "^11.1.3",
"@workday/canvas-kit-preview-react": "^11.1.3",
"@workday/canvas-kit-react": "^11.1.3",
"@workday/canvas-kit-styling": "^11.1.3",
"@workday/canvas-kit-labs-react": "^11.1.4",
"@workday/canvas-kit-preview-react": "^11.1.4",
"@workday/canvas-kit-react": "^11.1.4",
"@workday/canvas-kit-styling": "^11.1.4",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.0",
"markdown-to-jsx": "^7.2.0",
Expand Down
2 changes: 1 addition & 1 deletion modules/labs-css/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-labs-css",
"version": "11.1.3",
"version": "11.1.4",
"description": "The parent module that contains all Workday Canvas Kit Labs CSS components",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down
4 changes: 2 additions & 2 deletions modules/labs-react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-labs-react",
"version": "11.1.3",
"version": "11.1.4",
"description": "Canvas Kit Labs is an incubator for new and experimental components. Since we have a rather rigorous process for getting components in at a production level, it can be valuable to make them available earlier while we continuously iterate on the API/functionality. The Labs modules allow us to do that as needed.",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -46,7 +46,7 @@
"dependencies": {
"@emotion/react": "^11.7.1",
"@emotion/styled": "^11.6.0",
"@workday/canvas-kit-react": "^11.1.3",
"@workday/canvas-kit-react": "^11.1.4",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/design-assets-types": "^0.2.8",
"chroma-js": "^2.1.0",
Expand Down
2 changes: 1 addition & 1 deletion modules/popup-stack/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-popup-stack",
"version": "11.1.3",
"version": "11.1.4",
"description": "Stack for managing popup UIs to coordinate global concerns like escape key handling and rendering order",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion modules/preview-css/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-preview-css",
"version": "11.1.3",
"version": "11.1.4",
"description": "The parent module that contains all Workday Canvas Kit Preview CSS components",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down
6 changes: 3 additions & 3 deletions modules/preview-react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-preview-react",
"version": "11.1.3",
"version": "11.1.4",
"description": "Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -46,8 +46,8 @@
"dependencies": {
"@emotion/react": "^11.7.1",
"@emotion/styled": "^11.6.0",
"@workday/canvas-kit-react": "^11.1.3",
"@workday/canvas-kit-styling": "^11.1.3",
"@workday/canvas-kit-react": "^11.1.4",
"@workday/canvas-kit-styling": "^11.1.4",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.0",
"@workday/design-assets-types": "^0.2.8"
Expand Down
2 changes: 1 addition & 1 deletion modules/react-fonts/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-react-fonts",
"version": "11.1.3",
"version": "11.1.4",
"description": "Fonts for canvas-kit-react",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down
6 changes: 3 additions & 3 deletions modules/react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-react",
"version": "11.1.3",
"version": "11.1.4",
"description": "The parent module that contains all Workday Canvas Kit React components",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -49,8 +49,8 @@
"@emotion/styled": "^11.6.0",
"@popperjs/core": "^2.5.4",
"@workday/canvas-colors-web": "^2.0.0",
"@workday/canvas-kit-popup-stack": "^11.1.3",
"@workday/canvas-kit-styling": "^11.1.3",
"@workday/canvas-kit-popup-stack": "^11.1.4",
"@workday/canvas-kit-styling": "^11.1.4",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.0",
"@workday/design-assets-types": "^0.2.8",
Expand Down
4 changes: 2 additions & 2 deletions modules/styling-transform/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-styling-transform",
"version": "11.1.3",
"version": "11.1.4",
"description": "The custom CSS in JS solution that takes JS styles and turns them into static CSS",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -34,7 +34,7 @@
],
"dependencies": {
"@emotion/serialize": "^1.0.2",
"@workday/canvas-kit-styling": "^11.1.3",
"@workday/canvas-kit-styling": "^11.1.4",
"@workday/canvas-tokens-web": "^2.0.0",
"stylis": "4.0.13",
"typescript": "4.2"
Expand Down
4 changes: 2 additions & 2 deletions modules/styling/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@workday/canvas-kit-styling",
"version": "11.1.3",
"version": "11.1.4",
"description": "The custom CSS in JS solution that takes JS styles and turns them into static CSS",
"author": "Workday, Inc. (https://www.workday.com)",
"license": "Apache-2.0",
Expand Down Expand Up @@ -53,7 +53,7 @@
"@emotion/react": "^11.7.1",
"@emotion/serialize": "^1.0.2",
"@emotion/styled": "^11.6.0",
"@workday/canvas-kit-react": "^11.1.3",
"@workday/canvas-kit-react": "^11.1.4",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.0",
"typescript": "4.2"
Expand Down

0 comments on commit 1e0bc45

Please sign in to comment.