EPHEH-313: Color Schema v2. #581
Conversation
|
🚀 Deployed on https://preview-581--oelibrary.netlify.app |
builder/scripts/colorSchema.js
Outdated
| * | ||
| * Example config object: { | ||
| * | ||
| * color-schema: [ |
There was a problem hiding this comment.
this is already nice but for the final version I would like a proper docs page, where the purpose, prerequisites, usage are explained, including the possibility to use directly in a central sass file or through the builder, how the builder.config can be set up etc
Also words about what it offers, example usage of the classes, and about the mixins per components, how you can use them
There was a problem hiding this comment.
I wrote the documentation. Tell me please if it sounds clear:
https://github.com/openeuropa/bootstrap-component-library/tree/EPHEH-313-V2/builder
I added in the builder as always we had for all the scripts used.
builder/README.md
Outdated
| ```javascript | ||
| color-scheme: [ | ||
| { | ||
| entry (string - source file of color-schema), |
There was a problem hiding this comment.
its a bit unclear, maybe something more concrete but descriptive
| entry (string - source file of color-schema), | |
| entry ../path/to/you-colour-scheme.scss, |
builder/README.md
Outdated
| ```javascript | ||
| color-scheme: [ | ||
| { | ||
| entry (string - source file of color-schema), |
There was a problem hiding this comment.
rename all instances of schema to scheme
builder/README.md
Outdated
|
|
||
| The 'link' variable changes the color of all the links inside the schema. | ||
|
|
||
| All of these are possible through a namespace class `.{$color-schema-name}`. For example, a banner which uses the color schema will have class `'bcl-banner pixy-pink'`. |
builder/README.md
Outdated
| The color-scheme script makes use of these files like this: | ||
|
|
||
| ```javascript | ||
| const scssContent = imports + "\n" + entryVariables + "\n" + generator; | ||
| ``` | ||
|
|
||
| - Imports: The necessary imports from Bootstrap and also the mixins. | ||
| - EntryVariables: The Color schema added by the user (source file). | ||
| - Generator: The call of the mixins used. | ||
|
|
There was a problem hiding this comment.
I think again to much info
| * color-scheme: [ | ||
| * { | ||
| * entry: [path.resolve(nodeModules, "myfile.js")], | ||
| * dest: path.resolve(outputFolder, "js"), | ||
| * options: { | ||
| * includePaths, | ||
| * sourceMap: "file", | ||
| * }, |
There was a problem hiding this comment.
yes, something like this in the readme
There was a problem hiding this comment.
added also in readme.
* EPHEH-313: Color Schema v2. * EPHEH-313-V2: Fix for accordion. * EPHEH-313-V2: Fix for css. * EPHEH-313-V2: Fix for css. * EPHEH-313-v2: PR feedback. * EPHEH-313-v2: Changed color schema. * EPHEH-313: Color schema renaming to Color Scheme. * EPHEH-313: Improved. * EPHEH-313: Improved documentation. * EPHEH-313: Improved documentation. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. --------- Co-authored-by: Tiberiu Dumitru <[email protected]>
* EPHEH-313: Added yml-importer package. * Refactor approach. * Changed location of importer. * EPHEH-313: V1 color schema. * EPHEH-313: Removed base. * EPHEH-313: Color Schema v2. (#581) * EPHEH-313: Color Schema v2. * EPHEH-313-V2: Fix for accordion. * EPHEH-313-V2: Fix for css. * EPHEH-313-V2: Fix for css. * EPHEH-313-v2: PR feedback. * EPHEH-313-v2: Changed color schema. * EPHEH-313: Color schema renaming to Color Scheme. * EPHEH-313: Improved. * EPHEH-313: Improved documentation. * EPHEH-313: Improved documentation. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. * EPHEH-313: Updated doc. --------- Co-authored-by: Tiberiu Dumitru <[email protected]> * EPHEH-313: Updated readme. * EPHEH-313: Updated readme. * EPHEH-313: Feedback. * EPHEH-313: Fix for utilities classes. * EPHEH-313: Added facts icon to primary color and updated default color-scheme. * EPHEH-313: Improved classname. * EPHEH-313: Removed duplicated packages. --------- Co-authored-by: Tiberiu Dumitru <[email protected]>
No description provided.