Other documents:
📔 Getting Started 👷🏻 In deep 💡 Create components 📣 Modify component 📂 Deploy components
Documenting is one of the most fundamental processes when developing a component, it specifies the properties of the component, the component's behaviors, technical and design clarifications, styles, references, etc.
This provides a clarification of how it works and the limitations.
IMPORTANT: In any case, the developer should ask the Aqua team to upload the new document or update an existing document, as they are the only ones with access to the official documentation.
For order, security and maintenance the other developers can’t access to the official components documentation, so, to create the component documentation of a new component the developer can access to the Aqua Doc Template.
Template:
Component documentation template
The developer needs to search the “Code” section to add all that concerns to the component, in this may observe different subsections. ¿How know which subsection modify add or modify?
| Section | Description |
|---|---|
| How to use the component | Describes how do a implementation of the project, in which cases can use that and if the component is coupled to the user needs. |
| Props | Describes the props of the component with a table as a summary that display the type, description, possible values, default value and name of each prop. |
| Slots | Describes if the component has slots that can be access from the implementation and the description of the use of that. |
| Events | Describes in which cases a event is emitted by the component to the implementation, what does the trigger and if returns a value |
| Function | Describes the functions that can be use from the implementation to do an action inside the component, can be a close function, an emit, an value update, etc. |
| Interactions | Specifies the complex interactions that may have the component, how irregular functionalities or limitations between props, etc. |
To clarify, the unique section that can be modify by the developer is which concerns to the Code section, for the others respects to the Design process, the business component logic, the purpose and the reference to the creation of this one
The developer must give the info about the new prop with the format:
| Property Name | Type | Possible values | Description/Purpose | Default value |
|---|---|---|---|---|
| color | String | default, blue, green, red | Change the background color of the component | default |