Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to a39, enable new image widget #405

Merged
merged 6 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ core
.changelog.draft
build
.DS_Store
public
56 changes: 38 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,17 +232,24 @@ They will be noted properly in the changelog.

See a detailed upgrade guide in: https://github.com/kitconcept/volto-light-theme/blob/main/UPGRADE-GUIDE.md

## Development
## Compatibility

| VLT version | Volto version |
|-------------|---------------|
| 3.x.x | >= Volto 17.0.0-alpha.16 |
| 4.x.x | < Volto 17.18.0 |
| 5.x.x | >= Volto 17.18.0 or >=Volto 18.0.0-alpha.36 |

This theme works under Volto 17 alpha 16 onwards.
Compatibility with Volto 16 might be achieved, but it has to be at customization level in the
specific project add-on.
Compatibility with Volto 16 might be achieved, but it has to be at customization level in the specific project add-on.
This is mainly due to the `RenderBlocks` customization that is based in the one in 17 because of the Grid block in core and the autogrouping feature.
See more information about the other dependencies in `peerDependencies` in `package.json`.

## Development

The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest `mrs-developer` and other Volto core improvements.
For this reason, it only works with pnpm and Volto 18 (currently in alpha) but it does not mean that the add-on will only work in 18.

### Requisites
### Development requisites

- Volto 18 (2024-03-21: currently in alpha)
- pnpm as package manager
Expand All @@ -252,19 +259,32 @@ For this reason, it only works with pnpm and Volto 18 (currently in alpha) but i
Run `make help` to list the available commands.

```text
help Show this help
install Installs the dev environment using mrs-developer
i18n Sync i18n
format Format codebase
lint Lint Codebase
test Run unit tests
test-ci Run unit tests in CI
start-backend-docker Starts a Docker-based backend for developing
start-test-acceptance-frontend-dev Start acceptance frontend in dev mode
start-test-acceptance-frontend Start acceptance frontend in prod mode
start-test-acceptance-server Start acceptance server
test-acceptance Start Cypress in interactive mode
test-acceptance-headless Run cypress tests in headless mode for CI
help Show this help
install Installs the add-on in a development environment
start Starts Volto, allowing reloading of the add-on during development
build Build a production bundle for distribution of the project with the add-on
build-deps Build dependencies
i18n Sync i18n
ci-i18n Check if i18n is not synced
format Format codebase
lint Lint, or catch and remove problems, in code base
release Release the add-on on npmjs.org
release-dry-run Dry-run the release of the add-on on npmjs.org
test Run unit tests
ci-test Run unit tests in CI
backend-docker-start Starts a Docker-based backend for development
storybook-start Start Storybook server on port 6006
storybook-build Build Storybook
acceptance-frontend-dev-start Start acceptance frontend in development mode
acceptance-frontend-prod-start Start acceptance frontend in production mode
acceptance-backend-start Start backend acceptance server
ci-acceptance-backend-start Start backend acceptance server in headless mode for CI
acceptance-test Start Cypress in interactive mode
ci-acceptance-test Run cypress tests in headless mode for CI
acceptance-a11y-frontend-prod-start Start a11y acceptance frontend in prod mode
ci-acceptance-a11y-backend-start Start acceptance a11y server in CI mode (no terminal attached)
acceptance-a11y-test Start a11y Cypress in interactive mode
ci-acceptance-a11y-test Run a11y cypress tests in headless mode for CI
```

### Development Environment Setup
Expand Down
19 changes: 19 additions & 0 deletions UPGRADE-GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Upgrade Guide

## volto-light-theme 5.0.0

The requirements for VLT have changed:

| VLT version | Volto version |
|-------------|---------------|
| 3.x.x | >= Volto 17.0.0-alpha.16 |
| 4.x.x | < Volto 17.18.0 |
| 5.x.x | >= Volto 17.18.0 or >=Volto 18.0.0-alpha.36 |

## volto-light-theme 4.0.0

The tabbing order in the top header was fixed for accessibility concerns.
It modifies the underlying HTML to move the top header to the bottom, and modifies CSS to adjust.

The MobileNavigation component was updated to be more easily customizable.
The component can now handle infinite navigation depth instead of only three levels, if configured to do so.
The Burger Menu can now be easily customized by overriding the new MobileNavigationToggler.jsx file.

## volto-light-theme 3.0.0

### Blocks background colors go full width
Expand Down
2 changes: 1 addition & 1 deletion mrs.developer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"package": "@plone/volto",
"url": "git@github.com:plone/volto.git",
"https": "https://github.com/plone/volto.git",
"tag": "18.0.0-alpha.37"
"tag": "18.0.0-alpha.39"
},
"volto-button-block": {
"develop": false,
Expand Down
1 change: 1 addition & 0 deletions packages/volto-light-theme/news/405.breaking
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Upgrade to a39, enable new image widget @sneridagh
Loading