You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As Software Engineer
I want to have a consistent way of naming parameters
So that the user of the Design System can easier navigate our components
Description
We have inconsistent approach to naming parameters.
When dealing with a component that has a link with some text and a href we don't use the same name conventions
Naming convention for links in components
If the link is set at the top level of the component and there are no other parameters we should be using url and text
If the link is set at the top level and the are other parameters at the same level then we need to prefix url and text eg : postTextboxLinkTextpostTextboxLinkUrl.
If the link is set inside a parameter object then we should only use text and url.
For Document List we currently have
Document:
title
url
Type:
text
url
Acceptance criteria
Naming convention to this component has been agreed within Dev team.
Naming convention has been applied to the component.
Visualisation/Input from UCD
How should the components look like?
As Software Engineer
I want to have a consistent way of naming parameters
So that the user of the Design System can easier navigate our components
Description
We have inconsistent approach to naming parameters.
When dealing with a component that has a link with some text and a href we don't use the same name conventions
Naming convention for links in components
url
andtext
postTextboxLinkText
postTextboxLinkUrl
.text
andurl
.For Document List we currently have
Document:
Type:
Acceptance criteria
Visualisation/Input from UCD
How should the components look like?
Linked User stories/epics
Outcome of the spike
Technical details (optional)
Replace
title
andurl
with atitle
object that contains atext
andurl
paramsUpdate Metadata section params list e.g. "Type" should be "Object"
MVP (optional)
The text was updated successfully, but these errors were encountered: