qiskit.org/components
y4izus d865433eb1 Create AppCheckbox component 2020-12-15 17:46:47 -05:00
..
advocates Create AppCheckbox component 2020-12-15 17:46:47 -05:00
events Replace any type annotations for some files (#1148) 2020-12-04 12:08:33 +01:00
landing Provide the absolute URL to for browser navigation. (#1227) 2020-12-08 16:55:41 +01:00
layouts Update site desktop menu (#1196) 2020-12-14 18:26:15 -05:00
learn Unified and refactor CTAs and links (#1145) 2020-12-03 11:36:18 +01:00
logic Use named Vue component classes (#1130) 2020-11-23 16:20:01 +01:00
metal Replace any type annotations for some files (#1148) 2020-12-04 12:08:33 +01:00
overview Replace any type annotations for some files (#1148) 2020-12-04 12:08:33 +01:00
ui Create AppCheckbox component 2020-12-15 17:46:47 -05:00
README.md Remove element-related code (#718) 2020-07-16 20:39:38 +02:00

README.md

COMPONENTS

The components directory contains the Vue.js Components. We are working with the following structure to organize our components:

  • 📁 ui/ : Generic components like button, carousel, list, ... not related to an specific domain that can be reusable across the whole app
  • 📁 layout/ : Components that are used in the nuxt layouts folder (Header, Footer, ...). They are part of all pages.
  • 📁 logic/ : Components that only has logic inside, not <template> block
  • 📁 [domain]/ : Components that belong to a specific domain. The folder name should be the "domain" it refers to, having one folder per domain. For example, an AdvocateCard is related to the advocates domain, even if it is used in more than one place. If we have a generic card that can be used for both advocates and events (for example) it should go to ui. At the moment, we have the following domains:
    • 📁 advocates/
    • 📁 events/

You should also have in mind this guidelines:

  • If your component is compound of more subcomponents, make a folder called like the component (like with ui/footer).
  • If you add a component similar to another one, consider creating a folder with the naming the collection of components (as in ui/sections).