Merge branch 'main' into bugfix/fix-focus-visibility-dropdown

plone · Dec 17, 2024 · c0d3290 · c0d3290
2 parents 605f849 + 09b88e6
commit c0d3290
Show file tree

Hide file tree

Showing 89 changed files with 253 additions and 1,921 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,30 @@ You can build your own or choose from the community released ones:
 You can try a Volto online demo at [https://demo.plone.org/](https://demo.plone.org/).
 
 
+## Monorepo structure
+
+Since version 18.0.0-alpha4, the Volto core repository has had the shape of a monorepo, where "mono" means "single" and "repo" is short for "repository".
+This means that several apps and libraries related to each other are stored in the same repository.
+They are managed together but released individually.
+This allows the code to be shared effectively, and unifies tracking of changes across all of the apps and libraries.
+
+| Package | Location |
+|---|---|
+| [`@plone/client`](https://www.npmjs.com/package/@plone/client) | [`packages/client`](https://github.com/plone/volto/tree/main/packages/client#readme) |
+| [`@plone/components`](https://www.npmjs.com/package/@plone/components) | [`packages/components`](https://github.com/plone/volto/tree/main/packages/components#readme) |
+| [`@plone/generator-volto`](https://www.npmjs.com/package/@plone/generator-volto) | [`packages/generator-volto`](https://github.com/plone/volto/tree/main/packages/generator-volto#readme) |
+| [`@plone/helpers`](https://www.npmjs.com/package/@plone/helpers) | [`packages/helpers`](https://github.com/plone/volto/tree/main/packages/helpers#readme) |
+| [`@plone/providers`](https://www.npmjs.com/package/@plone/providers) | [`packages/providers`](https://github.com/plone/volto/tree/main/packages/providers#readme) |
+| [`@plone/registry`](https://www.npmjs.com/package/@plone/registry) | [`packages/registry`](https://github.com/plone/volto/tree/main/packages/registry#readme) |
+| [`@plone/scripts`](https://www.npmjs.com/package/@plone/scripts) | [`packages/scripts`](https://github.com/plone/volto/tree/main/packages/scripts#readme) |
+| [`@plone/types`](https://www.npmjs.com/package/@plone/types) | [`packages/types`](https://github.com/plone/volto/tree/main/packages/types#readme) |
+| none | [`packages/volto-guillotina`](https://github.com/plone/volto/tree/main/packages/volto-guillotina) |
+| [`@plone/volto-slate`](https://www.npmjs.com/package/@plone/volto-slate) | [`packages/volto-slate`](https://github.com/plone/volto/tree/main/packages/volto-slate#readme) |
+| [`@plone/volto-testing`](https://www.npmjs.com/package/@plone/volto-testing) | [`packages/volto-testing`](https://github.com/plone/volto/tree/main/packages/volto-testing) |
+
+See also [Monorepo structure](https://6.docs.plone.org/volto/contributing/developing-core.html#monorepo-structure).
+
+
 ## Create a Volto project
 
 To start a new project using Volto, follow the [Plone installation documentation](https://6.docs.plone.org/install/create-project.html).

diff --git a/apps/nextjs/package.json b/apps/nextjs/package.json
@@ -18,7 +18,7 @@
     "@tanstack/react-query": "^5.59.0",
     "next": "14.2.14",
     "react": "^18",
-    "react-aria-components": "^1.4.0",
+    "react-aria-components": "^1.5.0",
     "react-dom": "^18"
   },
   "devDependencies": {

diff --git a/apps/vite-ssr/package.json b/apps/vite-ssr/package.json
@@ -24,7 +24,7 @@
     "axios": "^1.6.5",
     "get-port": "^7.0.0",
     "react": "^18.2.0",
-    "react-aria-components": "^1.4.0",
+    "react-aria-components": "^1.5.0",
     "react-dom": "^18.2.0",
     "sirv": "^2.0.4"
   },

diff --git a/apps/vite/package.json b/apps/vite/package.json
@@ -19,7 +19,7 @@
     "@tanstack/router-devtools": "^1.67.0",
     "axios": "^1.6.5",
     "react": "^18.2.0",
-    "react-aria-components": "^1.4.0",
+    "react-aria-components": "^1.5.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {

diff --git a/docs/source/configuration/settings-reference.md b/docs/source/configuration/settings-reference.md
@@ -463,6 +463,13 @@ querystringSearchGet
     [See an explanation of character limits in URLs](https://stackoverflow.com/questions/417142/what-is-the-maximum-length-of-a-url-in-different-browsers/417184#417184).
     Please test this setting properly before enabling in a production site.
 
+cssLayers
+   To use CSS layers when styling Volto, you can define and apply them at the very top level of the page, where they appear in the `<head>` tag.
+    By using this configuration, you can pass the layer list definition as an array:
+
+    ```js
+    config.settings.cssLayers = ['reset', 'plone-components', 'layout', 'addons', 'theme'];
+    ```
 ```
 
 ## Views settings

diff --git a/docs/source/contributing/developing-core.md b/docs/source/contributing/developing-core.md
@@ -42,32 +42,35 @@ The workspaces are located in the `packages` or `apps` folder.
 ### Folder layout
 
 Volto has the following folder structure.
+The package `volto` is the core code of Volto.
 
 ```text
-(volto-monorepo)/
+/
 ├─ apps/
-│  ├─ plone
 │  ├─ nextjs
 │  ├─ remix
-│  └─ rr7
+│  ├─ rr7
+│  ├─ vite
+│  └─ vite-ssr
+├─ ...
 ├─ packages/
-│  ├─ volto
+│  ├─ blocks
 │  ├─ client
 │  ├─ components
-│  ├─ registry
-│  ├─ types
 │  ├─ coresandbox
 │  ├─ generator-volto
+│  ├─ helpers
+│  ├─ providers
+│  ├─ registry
 │  ├─ scripts
+│  ├─ slots
+│  ├─ theming
 │  ├─ tsconfig
+│  ├─ types
+│  ├─ volto
 │  ├─ volto-guillotina
 │  ├─ volto-slate
 │  └─ volto-testing
-├─ .gitignore
-├─ package.json
-├─ pnpm-workspace.yaml
-├─ turbo.json
-├─ tsconfig.json
 ├─ ...
 ```
 

diff --git a/docs/source/release-notes/index.md b/docs/source/release-notes/index.md
@@ -17,6 +17,20 @@ myst:
 
 <!-- towncrier release notes start -->
 
+## 18.4.0 (2024-12-17)
+
+### Feature
+
+- Added a setting in the `config` object to set the site's CSS layers, if required. @sneridagh [#6539](https://github.com/plone/volto/issues/6539)
+
+### Internal
+
+- Fixed and re-enabled the types declaration extractor from core Volto. @sneridagh [#6534](https://github.com/plone/volto/issues/6534)
+
+### Documentation
+
+- Add monorepo structure to the README. Update the monorepo structure file tree. @stevepiercy [#6542](https://github.com/plone/volto/issues/6542)
+
 ## 18.3.0 (2024-12-12)
 
 ### Feature

diff --git a/packages/blocks/Image/index.tsx b/packages/blocks/Image/index.tsx
@@ -1,4 +1,4 @@
-import { BlockViewProps } from '@plone/types';
+import type { BlockViewProps } from '@plone/types';
 import { usePloneProvider } from '@plone/providers';
 
 const ImageBlockView = (props: BlockViewProps) => {

diff --git a/packages/blocks/RenderBlocks/BlockWrapper.tsx b/packages/blocks/RenderBlocks/BlockWrapper.tsx
@@ -1,4 +1,4 @@
-import { ReactNode } from 'react';
+import type { ReactNode } from 'react';
 import cx from 'clsx';
 import type { RenderBlocksProps } from './RenderBlocks';
 

diff --git a/packages/blocks/Teaser/index.tsx b/packages/blocks/Teaser/index.tsx
@@ -1,4 +1,4 @@
-import { BlockViewProps } from '@plone/types';
+import type { BlockViewProps } from '@plone/types';
 import { Link } from '@plone/components';
 
 const TeaserBlockView = (props: BlockViewProps) => {

diff --git a/packages/blocks/index.ts b/packages/blocks/index.ts
@@ -1,4 +1,4 @@
-import { ConfigType } from '@plone/registry';
+import type { ConfigType } from '@plone/registry';
 import { slate } from './config/slate';
 import { blocksConfig } from './config';
 

diff --git a/packages/blocks/news/6536.internal b/packages/blocks/news/6536.internal
@@ -0,0 +1 @@
+Centralize `tsconfig`. @sneridagh
diff --git a/packages/blocks/package.json b/packages/blocks/package.json
@@ -28,9 +28,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "main": "index.ts",
   "scripts": {
     "test": "vitest",
+    "check-ts": "tsc --project tsconfig.json",
     "dry-release": "release-it --dry-run",
     "release": "release-it",
     "release-major-alpha": "release-it major --preRelease=alpha",

diff --git a/packages/components/CHANGELOG.md b/packages/components/CHANGELOG.md
@@ -8,6 +8,16 @@
 
 <!-- towncrier release notes start -->
 
+## 3.0.1 (2024-12-17)
+
+### Bugfix
+
+- Fixed precedence of the Quanta layer by adding a base layer for all the basic components. @sneridagh [#6539](https://github.com/plone/volto/issues/6539)
+
+### Internal
+
+- Update `@plone/components`'s URLs in its `package.json`. @stevepiercy [#6542](https://github.com/plone/volto/issues/6542)
+
 ## 3.0.0 (2024-12-12)
 
 ### Breaking

diff --git a/packages/components/README.md b/packages/components/README.md
@@ -62,11 +62,19 @@ Using them as a baseline will allow you to quickly build your theme around them.
 `@plone/components` basic styles provide a simple, yet powerful, set of tokenized custom CSS properties that will help you customize your own styles on the top of the basic styling.
 You can override them in your classes while maintaining them for others.
 
+### CSS layers
+
+This package uses CSS layers to style the components in a more flexible way.
+It uses the `plone-components` layer name to scope all the CSS declarations in the package.
+The basic styling uses the nested `plone-components.base` named layer.
+You can use the `plone-components` layer to override the basic styling, or use the `plone-components.base` layer to override the basic styling in a more specific way.
+
 ### Quanta
 
 This package also features the Quanta components.
-The Quanta theme is an example of it.
-These components use the basic styling as a baseline, not only in styling, but also in the component side, reusing the CSS and custom CSS properties in it.
+These components use the basic styling as a baseline, extending them to achieve the Quanta look and feel.
+They also extend the basic React components in a composable way.
+The Quanta styling is scoped in the `plone-components.quanta` named layer.
 
 Quanta is built upon the basic styles in an additive way.
 The use of the Quanta CSS implies using it upon basic styling.

diff --git a/packages/components/package.json b/packages/components/package.json
@@ -8,13 +8,13 @@
     }
   ],
   "license": "MIT",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "repository": {
     "type": "git",
-    "url": "http://github.com/plone/components.git"
+    "url": "http://github.com/plone/volto.git"
   },
   "bugs": {
-    "url": "https://github.com/plone/components/issues"
+    "url": "https://github.com/plone/volto/issues"
   },
   "type": "module",
   "files": [

diff --git a/packages/components/src/stories/Introduction.mdx b/packages/components/src/stories/Introduction.mdx
@@ -5,16 +5,17 @@ import { Meta } from '@storybook/blocks';
 
 # `@plone/components`
 
-This package contains ReactJS components for using Plone as a headless CMS.
+This package contains ReactJS components for Plone 7 and Plone's API-first CMS story.
 
 The purpose of this package is to provide an agnostic set of baseline components to build Plone sites upon.
 
 ## Usage
 
-Using the package manager of your choice (npm, yarn, pnpm) install the package:
+You can use your choice of package manager (npm, yarn, or pnpm) to install the package in your app.
+If you add the components to a Volto add-on or workspace, use pnpm, as shown.
 
 ```shell
-yarn add @plone/components
+pnpm add @plone/components
 ```
 
 Whenever you want to use the components, all are exported as named exports:
@@ -53,12 +54,19 @@ or selectively:
 import '@plone/components/src/styles/basic/TextField.css';
 ```
 
+### CSS layers
 
-## Quanta
+This package uses CSS layers to style the components in a more flexible way.
+It uses the `plone-components` layer name to scope all the CSS declarations in the package.
+The basic styling uses the nested `plone-components.base` named layer.
+You can use the `plone-components` layer to override the basic styling, or use the `plone-components.base` layer to override the basic styling in a more specific way.
+
+### Quanta
 
 This package also features the Quanta components.
-The Quanta theme is an example of it.
-These components use the basic styling as a baseline, not only in styling, but also in the component side, reusing the CSS and custom CSS properties in it.
+These components use the basic styling as a baseline, extending them to achieve the Quanta look and feel.
+They also extend the basic React components in a composable way.
+The Quanta styling is scoped in the `plone-components.quanta` named layer.
 
 Quanta is built upon the basic styles in an additive way.
 The use of the Quanta CSS implies using it upon basic styling.

diff --git a/packages/components/src/styles/basic/BlockToolbar.css b/packages/components/src/styles/basic/BlockToolbar.css
@@ -4,7 +4,7 @@
 @import './Menu.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .blocks-toolbar {
     display: flex;
     flex-wrap: wrap;

diff --git a/packages/components/src/styles/basic/Breadcrumbs.css b/packages/components/src/styles/basic/Breadcrumbs.css
@@ -1,6 +1,6 @@
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-Breadcrumbs {
     display: flex;
     align-items: center;

diff --git a/packages/components/src/styles/basic/Button.css b/packages/components/src/styles/basic/Button.css
@@ -1,6 +1,6 @@
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-Button {
     padding: 8px 8px;
     border: 1px solid var(--border-color);

diff --git a/packages/components/src/styles/basic/Calendar.css b/packages/components/src/styles/basic/Calendar.css
@@ -1,7 +1,7 @@
 @import './Button.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-Calendar {
     width: fit-content;
     max-width: 100%;

diff --git a/packages/components/src/styles/basic/Checkbox.css b/packages/components/src/styles/basic/Checkbox.css
@@ -1,6 +1,6 @@
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-Checkbox {
     --selected-color: var(--highlight-background);
     --selected-color-pressed: var(--highlight-background-pressed);

diff --git a/packages/components/src/styles/basic/CheckboxGroup.css b/packages/components/src/styles/basic/CheckboxGroup.css
@@ -3,7 +3,7 @@
 @import './Button.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-CheckboxGroup {
     display: flex;
     flex-direction: column;

diff --git a/packages/components/src/styles/basic/ColorArea.css b/packages/components/src/styles/basic/ColorArea.css
@@ -1,6 +1,6 @@
 @import './ColorSlider.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorArea {
     width: 192px;
     height: 192px;

diff --git a/packages/components/src/styles/basic/ColorField.css b/packages/components/src/styles/basic/ColorField.css
@@ -2,7 +2,7 @@
 @import './Form.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorField {
     display: flex;
     flex-direction: column;

diff --git a/packages/components/src/styles/basic/ColorPicker.css b/packages/components/src/styles/basic/ColorPicker.css
@@ -10,7 +10,7 @@
 @import './Select.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .color-picker {
     display: flex;
     align-items: center;

diff --git a/packages/components/src/styles/basic/ColorSlider.css b/packages/components/src/styles/basic/ColorSlider.css
@@ -1,4 +1,4 @@
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorSlider {
     display: grid;
     max-width: 300px;

diff --git a/packages/components/src/styles/basic/ColorSwatch.css b/packages/components/src/styles/basic/ColorSwatch.css
@@ -1,6 +1,6 @@
 @import './ColorSlider.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorSwatch {
     width: 32px;
     height: 32px;

diff --git a/packages/components/src/styles/basic/ColorSwatchPicker.css b/packages/components/src/styles/basic/ColorSwatchPicker.css
@@ -2,7 +2,7 @@
 @import './ColorField.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorSwatchPicker {
     display: flex;
     flex-wrap: wrap;

diff --git a/packages/components/src/styles/basic/ColorWheel.css b/packages/components/src/styles/basic/ColorWheel.css
@@ -1,4 +1,4 @@
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ColorThumb {
     width: 20px;
     height: 20px;

diff --git a/packages/components/src/styles/basic/ComboBox.css b/packages/components/src/styles/basic/ComboBox.css
@@ -5,7 +5,7 @@
 @import './Button.css';
 @import './theme.css';
 
-@layer plone-components {
+@layer plone-components.base {
   .react-aria-ComboBox {
     color: var(--text-color);
 

diff --git a/packages/components/src/styles/basic/Container.css b/packages/components/src/styles/basic/Container.css
@@ -1,4 +1,4 @@
-@layer plone-components {
+@layer plone-components.base {
   .q.container {
     container-type: inline-size;