openeuropa / oe_whitelabel
OpenEuropa Whitelabel theme.
Installs: 18 995
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 18
Forks: 4
Open Issues: 35
Type:drupal-theme
Requires
- php: >=8.1
- cweagans/composer-patches: ^1.7
- drupal/core: ^10
- drupal/daterange_compact: ^2.0.1
- drupal/twig_field_value: ^2.0.2
- openeuropa/composer-artifacts: ^1.0.0-alpha1
- openeuropa/oe_bootstrap_theme: ^1.17
Requires (Dev)
- composer/installers: ^1.11
- drupal/better_exposed_filters: ^6.0.3
- drupal/color_scheme_field: ^1.0@alpha
- drupal/composite_reference: ^2.2
- drupal/config_devel: ~1.9
- drupal/core-composer-scaffold: ^10
- drupal/core-dev: ^10
- drupal/description_list_field: ^1.0@alpha
- drupal/entity_reference_revisions: ^1.11
- drupal/extra_field: ^2.3
- drupal/facets_form: ^1.0.0-alpha6
- drupal/field_group: ^3.4
- drupal/paragraphs: ^1.17
- drupal/search_api: ^1.29
- drupal/search_api_autocomplete: ^1.7
- drupal/typed_link: ^2.0.1
- drush/drush: ^12
- mikey179/vfsstream: ^1.6.10
- nikic/php-parser: ^4
- openeuropa/code-review: ^2.0.0-alpha6
- openeuropa/oe_agenda: ^1.0.0-alpha3
- openeuropa/oe_authentication: ^1.11
- openeuropa/oe_contact_forms: ~1.11
- openeuropa/oe_content: ^3
- openeuropa/oe_content_extra: ^1.1.0
- openeuropa/oe_corporate_blocks: ^4.20
- openeuropa/oe_link_lists: ^1.0
- openeuropa/oe_list_pages: ^1.0.0
- openeuropa/oe_multilingual: ^1.14
- openeuropa/oe_paragraphs: ^1.20
- openeuropa/oe_starter_content: ^1.2.0
- openeuropa/oe_subscriptions: ^1.0@alpha
- openeuropa/task-runner-drupal-project-symlink: ^1.0-beta6
- phpspec/prophecy-phpunit: ^2
Conflicts
- 1.x-dev
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 1.0.0-beta7
- 1.0.0-beta6
- 1.0.0-beta5
- 1.0.0-beta4
- 1.0.0-beta3
- 1.0.0-beta2
- 1.0.0-beta1
- 1.0.0-alpha7
- 1.0.0-alpha6
- 1.0.0-alpha5
- 1.0.0-alpha4
- 1.0.0-alpha3
- 1.0.0-alpha2
- 1.0.0-alpha1
- 0.301020210016
- 0.281020211720
- 0.271020210914
- 0.241020211240
- 0.181120211522
- 0.161120211215
- 0.031120211510
- 0.021120211326
- 0.3423.202410171530
- 0.3422.202411041545
- 0.3074.202430081505
- 0.2767.202402021158
- 0.2767.202303041517
- 0.2604.202407031732
- 0.2527.202406111450
- 0.2070.202211072100
- 0.2070.202210281703
- 0.2002.202209290753
- 0.2002.202209141424
- 0.1919.202208091506
- 0.1919.202208091406
- 0.1913.202208301702
- 0.1910.202209271137
- 0.1900.202208161822
- 0.1823.202207081545
- 0.1618.202206241439
- 0.1618.202206101710
- 0.1618.202206071325
- 0.1618.202206031350
- 0.1618.202206031240
- 0.1618.202205191930
- 0.1452.202204201745
- 0.1418.202205311230
- 0.1416.202204221639
- 0.1416.202204151501
- 0.1414.202210140934
- 0.1414.202210111411
- 0.1317.202203241750
- 0.1317.202203241730
- 0.1307.202203281920
- 0.1307.202203211515
- 0.1307.202203181550
- 0.1307.202203171255
- 0.1307.202203171200
- 0.1307.202203171100
- 0.1307.202203101115
- 0.1281.202203301352
- 0.1281.202203301327
- 0.1167.202203181408
- 0.1167.202203181307
- 0.1092.202202031208
- 0.1092.202202021605
- 0.836.202202071645
- 0.836.202202071130
- 0.823.202201111243
- 0.823.202201111236
- 0.779.202202021800
- 0.779.202202021720
- 0.779.202202021100
- 0.779.202202020955
- 0.601.202112031716
- 0.318.202407301150
- 0.318.202406181030
- 0.1.202301301719
- 0.1.202212091921
- 0.1.202211091028
- 0.1.202210271621
- 0.1.202209022323
- 0.1.202208221749
- 0.1.202208051048
- 0.1.202207271650
- 0.1.202206291849
- 0.1.202206241900
- 0.1.202206092103
- 0.1.202206071821
- 0.1.202206071249
- 0.1.202204221923
- 0.1.202204061246
- 0.1.202203291000
- 0.1.202203211838
- 0.1.202203181300
- 0.1.202203081055
- 0.1.202203021707
- 0.1.202202240940
- 0.1.202202221259
- 0.1.202202221138
- 0.1.202202080830
- 0.1.202202071145
- 0.1.202202041907
- 0.1.20240806928
- dev-release-1.14.0
- dev-OEL-3503
- dev-contribution/UCPKN-3056
- dev-fix-js-console-error
- dev-OEL-3354
- dev-OEL-3368
- dev-OEL-3423
- dev-OEL-3422
- dev-OEL-3420
- dev-OEL-3419
- dev-OEL-2742
- dev-OEL-2289
- dev-contribution/UCPKN-2600
- dev-contribution/EPHEH-318
- dev-OEL-3158
- dev-POC/OEL-3000
- dev-contribution/EPHEH-465
- dev-OEL-3000
- dev-ISSUE-246
- dev-contribution/ELA-650
- dev-poc-link-lists
- dev-OEL-1657
- dev-EPHEH-73
- dev-OEL-2272
- dev-OEL-2262
- dev-OEL-2297
- dev-OEL-2263
- dev-EPIC-1450-List-pages
- dev-EPIC-1293-Project
- dev-DEMO-OEL-1367-theme-hook-suggestions
- dev-OEL-1668-test
- dev-OEL-1418
- dev-OEL-1463
- dev-EPIC-1450-List-Solution
- dev-EPIC-OEL-1450-List-pages
- dev-OEL-1452
- dev-OEL-1241
- dev-OEL-1227-tests-only
- dev-OEL-1283-enhance-readme
- dev-OEL-1239
- dev-EPIC-1147-navigation
- dev-EPIC-User_profile
- dev-OEL-823
- dev-OEL-477
- dev-OEL-718
- dev-OEL-481
- dev-OEL-477-user-fields
- dev-OEL-732
- dev-OEL-587
- dev-OEL-589
- dev-OEL-648
- dev-OEL-540
- dev-OEL-478
- dev-demo
This package is auto-updated.
Last update: 2024-12-17 09:48:17 UTC
README
Sub-theme of OpenEuropa Bootstrap base theme, with theming for OpenEuropa library features.
Features
Paragraphs
The paragraphs below are not yet themed therefore not recommended for usage:
- Contextual navigation
- Document
Some paragraphs are considered "internal", and only meant to be used inside other paragraphs:
- Listing item: To be used as item paragraph within 'Listing item block'.
- Fact: To be used as item paragraph within 'Facts and figures'.
Usage as a dependency
Website projects can use oe_whitelabel
either as an active theme, or they can create a custom theme using oe_whitelabel
as a base theme.
Requirements
The package is meant for Drupal projects that manage their dependencies with Composer.
Ideally this project should be managed with Docker and Docker Compose, but this is not a hard requirement.
Check the composer.json for required PHP version and other dependencies.
Add the composer package
Add this manually in composer.json, or combine with existing entries:
"extra": {
"artifacts": {
"openeuropa/oe_bootstrap_theme": {
"dist": {
"url": "https://github.com/{name}/releases/download/{pretty-version}/{project-name}-{pretty-version}.zip",
"type": "zip"
}
},
"openeuropa/oe_whitelabel": {
"dist": {
"url": "https://github.com/{name}/releases/download/{pretty-version}/{project-name}-{pretty-version}.zip",
"type": "zip"
}
}
}
}
While this package is still in its alpha
phase, you need an extra step in composer, to avoid getting anything from the obsolete and unsupported 0.x
branch.
One option is to set minimum-stability
and require the ^1.0
version.
You should also set prefer-stable
to mitigate the impact on other dependencies.
Review this again when the site goes into production.
composer config minimum-stability alpha
composer config prefer-stable true
composer require openeuropa/oe_whitelabel:^1.0
Alternatively, if you don't want to set minimum-stability
, you need to specify explicit versions for all dependencies with alpha versions:
composer require openeuropa/oe_whitelabel:^1.0@alpha openeuropa/oe_bootstrap_theme:^1.0@alpha
Review the installed package versions.
composer show -i | grep oe_
Enable and configure
Enable required and optional submodules:
# Always required. ./vendor/bin/drush en oe_whitelabel_helper # Required, if you use oe_paragraphs module, or if you copied any paragraph # types from that module. ./vendor/bin/drush en oe_whitelabel_paragraphs # Other submodules are optional - check the /modules/ folder. ./vendor/bin/drush en <modulename>
Enable the theme and set as default:
./vendor/bin/drush config-set system.theme default oe_whitelabel
Development setup
Using LAMP stack or similar
This is not officially supported. You are on your own.
Using Docker Compose
Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.
Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.
Requirements
Configuration
By default, Docker Compose reads two files, a docker-compose.yml
and an optional docker-compose.override.yml
file.
By convention, the docker-compose.yml
contains your base configuration and it's provided by default.
The override file, as its name implies, can contain configuration overrides for existing services or entirely new
services.
If a service is defined in both files, Docker Compose merges the configurations.
Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.
Start the container
If you have other (daemonized) containers running, you might want to stop them first:
docker stop $(docker ps -q)
To start, run:
docker-compose up
It's advised to not daemonize docker-compose
so you can turn it off (CTRL+C
) quickly when you're done working.
However, if you'd like to daemonize it, you have to add the flag -d
:
docker-compose up -d
Optionally purge existing installation
If you already had the package installed, and want a clean start:
docker-compose exec web rm composer.lock docker-compose exec web rm -rf vendor/ docker-compose exec web rm -rf build/
Install the package
docker-compose exec -u node node npm install docker-compose exec -u node node npm run build docker-compose exec web composer install docker-compose exec web ./vendor/bin/run drupal:site-install
Using default configuration, the development site files should be available in the build
directory and the development site should be available at: http://127.0.0.1:8080/build or http://web:8080/build.
Run the tests
To run the grumphp checks:
docker-compose exec web ./vendor/bin/grumphp run
To run the phpunit tests:
docker-compose exec web ./vendor/bin/phpunit
Upgrade from older versions
Upgrade to 1.0.0-alpha7
Paragraphs migration
Paragraphs-related theming and functionality has been moved from the OpenEuropa Bootstrap base theme to OpenEuropa Whitelabel.
Special paragraphs fields that were introduced in oe_bootstrap_theme_paragraphs
are being renamed in oe_whitelabel_paragraphs
.
If you have the oe_paragraphs
module enabled, you should create a hook_post_update_NAME()
in your code, to enable the oe_whitelabel_paragraphs
module during deployment.
function EXAMPLE_post_update_00001(): void { \Drupal::service('module_installer')->install(['oe_whitelabel_paragraphs']); }
This is needed to make sure that the install hook for oe_whitelabel_paragraphs
runs before config-import during a deployment.
Note that drush updb
will also trigger update hooks in oe_bootstrap_theme_helper
, which will uninstall the legacy module oe_bootstrap_theme_paragraphs
.
Upgrade to 1.0.0-alpha6
This release contains some bugs, please move directly to alpha7.