CC Open Source Blog

CC Vocabulary: the main course

by Dhruv Bhanushali on Friday, 2019-07-19

This blog is part of the series: GSoC 2019: CC Vocabulary

A little over seven weeks ago we initialised CC Vocabulary. It was a simple recipe, a set of components for other apps to use for consistency and ease of development.

  • Week 1: we assembled the ingredients: Vue CLI, Vue Styleguidist, Theo, Lodash, Font Awesome.
  • Week 2: we cleaned up the kitchen: Dockerised our project and set up CI/CD.
  • Week 3: we ground spices: developed and incorporated design tokens.
  • Weeks 4-5: we cooked appetizers: our collection of simple Elements.
  • Weeks 6-7: we cooked the main dishes: our collection of very functional Patterns and Layouts.
  • Last week: we garnished these dishes: a splash of styling for the styleguide itself.

Today, main course is served, hot.

Grab your forks, knives and spoons for today we announce that CC Vocabulary is now very stable, has a lot of valuable, nay indispensable features such as mobile responsiveness and i18n and, best of all, embodies the vibrancy of Creative Commons in its versatile customisability and its collection of 36 hues and 8 greyscale tones usable across dozens of elements and patterns.

Based on the facts that fewer and fewer changes are being made to the core functionality with every commit, that there is a definite coding and nomenclature scheme, that desirable consistency has been achieved across its myriad of offerings and that a number of features have been frozen, I am very confident that CC Vocabulary is nearing its public release and into version 1.0.0.

As we head into the next phase of Vocabulary, i.e. using it in our very own apps, here is a comprehensive look on where we stand right now in terms of what the library provides. The goal of this exercise is to determine what elements and/or patterns have been overlooked and to determine additional functionality that may be required in some of them. Since every component can be customised tweaked and extended, an interactive exploration is preferable but to get you hyped up for the meal, here are some pictures of what to expect.

If you are a developer of CC applications, please take the time to visit the styleguide and play around with these components so that you may identify shortcomings or ideas for improvement. If you are an explorer, do so for the thrill of seeing a design system take shape. Any and all contributions are welcome in this crucial moment as our beloved brainchild comes of age.

Presenting to you our special menu of Vue components.

Component Image
Tokens
Colors colors_image
Fonts fonts_image
Spaces spaces_image
Elements
Button button_image
InputField inputfield_image
SelectField selectfield_image
Heading heading_image
Paragraph paragraph_image
LicenseBadge licensebadge_image
LicenseIconography licenseiconography_image
ProgressBar progressbar_image
Shield shield_image
Layouts
Container container_image
Grid grid_image
Table table_image
Patterns
Header header_image
Footer footer_image
Locale locale_image
Hello hello_image
Templates
Index

 

What's next

There are a number of components under construction right now such as cards and social media buttons. They will be published on the styleguide very soon. After these, the final month, phase III of of the project's GSoC term will be spent continuously polishing the project to suit the needs of all CC apps as discovered during the integration with CC Search as mentioned by Breno Ferreira in the 'Next steps' in his post on CC Search Redesign.

In keeping with the culinary theme of this post, think of it as sweet sweet dessert.

Closing note

In closing, I would like to thank my GSoC mentor Hugo Solar as always for always being present to help and refer me to documentation that I would likely never have found myself. Also I extend thanks to Kriti Godey for regularly keeping in touch and directing me to the right people to contact whenever in difficulty.

CC Vocabulary is for, by, inspired from and due to the diverse and active Creative Commons community.

Oh and one more thing...

I buried an easter egg inside this article indicative of the fun nature of the library. See if you can find it. Looking into the source code is cheating.

See you in two weeks with more updates (... and the aforementioned dessert).

Back to top