Other documents:
📔 Getting Started
👷🏻 In deep
📣 Modify component
📂 Deploy components
📝 Document component
Foundation
In the creation creating process of a component the design is one of the most fundamental steps, without the design the developer can’t know the component composition, behaviors between variants and other fundamental considarations, so, before starting to code the developer should follow the guidelines of the ***UX Team,*** check the Aqua Team response about the new component or new change and needs the approval of the requesting team lead.
With a design as a base, the developers must be respect each style of the element (Spacings, Size, Weights, etc) and contemplate all the variants to keep the graphic standar inside the application. Each design provide the possible variants/status of a component, a specification of the component composition and multiple examples of behavior between variants, all of this items must be added in the component logic and behavior.
Important Considerations
- To the Aqua Team approve the component creation idea, is necessary have the check of the UI/UX Designer, Developers responsibles of Aqua and the Aqua Team Lead
- Is important understand that Aqua is a transversal library which can be installed in a any project that has implemented the @oasis/libraries.
- It must make sense both as an individual component and as a coexisting fragment of the web application
- For example, the Scroll Helper doesn’t is a component because is a basic DOM Element that makes no sense create as a component
- The Autocomplemente makes sense because is a complex element that can be used in any part of the application
- There variants (As the disable, active, etc) must coincide each others components
- Example, if the error variant of the component have a blue outline, this one comes out of the graphic line of the application therefore will not be approved.
- In the case, that the requested component only will be used in one view or a team, the responsability of the creation of the component becomes the responsibility of the requesting team.
- The behavior and business logic of the component must be clearly understood and documentate.
⏫ Top of page
Related documents:
💡 Testing
💡 How to create a component?