Documented: dxpImage, dxpUserProfile ,dxpOmsInstanceNaviagtor components to understand their working #257
Conversation
…nts to understand their working
…nts to understand their working
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Prop Name</th> |
There was a problem hiding this comment.
we can just say "prop" here instead of "prop name"
| <tbody> | ||
| <tr> | ||
| <td><code>src</code></td> | ||
| <td>It's specifying that the component expects a prop named src.n this component props.src to access the value of the src.</td> |
There was a problem hiding this comment.
confusingly worded, please clarify
|
|
||
|
|
||
| ## Recommendation | ||
| <li>Use the component to load and display images stored as local assets within the project directory.</li> |
There was a problem hiding this comment.
This information is redundant and doesn't add anything new from what was already written above. We should convey to the user:
What does this component offer as a value that users did not have already.
Some example use cases with code of how to use it in that scenario.
|
|
||
|
|
||
| ### state manamement | ||
| #### 1.useAuthStore() |
There was a problem hiding this comment.
this part feels incomplete in regards to what we are trying to communicate. How is this connected to this component. Is there a step 2?
| ### Events | ||
| #### 1. goToOms() | ||
| <li>The purpose of goToOms is to navigate the user to a different screen or page within the application that corresponds to a specific OMS instance. | ||
| <li>It takes two parameters: <b>token</b> (an authentication token) and <b>omsName</b> (the name of the OMS instance). |
There was a problem hiding this comment.
The example we have given above does not include these parameters. Are these given as props? are these values expected in a state somewhere?
|
|
||
| ## DxpUserProfile | ||
| ### Introduction | ||
| <li>The User Profile Card component is designed to display user profile information, allowing users to see details such as their login ID and party name. It also provides options to perform actions like logging out and navigating to the launchpad. |
There was a problem hiding this comment.
| <li>The User Profile Card component is designed to display user profile information, allowing users to see details such as their login ID and party name. It also provides options to perform actions like logging out and navigating to the launchpad. | |
| <li>The User Profile Card component is designed to display user profile information, allowing users to see details such as their login ID and party name. It also provides options to perform actions like logging out and navigating to the Launchpad. |
|
|
||
| ### Events | ||
| #### 1. logout() | ||
| The logout() method is triggered when the user clicks on the logout button (ion-button). It initiates the logout process for the user. |
There was a problem hiding this comment.
| The logout() method is triggered when the user clicks on the logout button (ion-button). It initiates the logout process for the user. | |
| The logout() method is triggered when the user clicks on the logout button, initiating the logout process for the user. |
| #### 2. goToLaunchpad() | ||
| The goToLaunchpad() method is invoked when the user clicks on the "Go To Launchpad" button. It redirects the user to the launchpad by changing the window location. | ||
|
|
||
| ### CSS |
There was a problem hiding this comment.
I don't think we need to really go this deep into the code in this draft. Lets focus on the functionality and usage first.
Documented the dxp-components to understand their working such that they can be seamlessly integrated into projects according to the requirement.