Rename name of date-input component to namePrefix
#984
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is better reflective of the purpose of the argument, which is to prefix the `name` attribute of `items`. This naming is consistent with other components which use the name `idPrefix` to explain similar functionality.
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-984
hannalaakso
force-pushed
the
amend-name-for-date-input-api
branch
from
a7f4153
to
3c9dba0
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-984
36degrees
approved these changes
Sep 6, 2018
| @@ -72,6 +72,14 @@ | |||
|
|
|||
| ([PR #969](https://github.com/alphagov/govuk-frontend/pull/969)) | |||
|
|
|||
| - Rename `name` argument of date-input component to `namePrefix`. | |||
|
|
|||
| This is better reflective of the purpose of the argument, which is to prefix the `name` attribute of `items`. This is consistent with other components which use the name `idPrefix` to explain similar functionality. | |||
There was a problem hiding this comment.
Great changelog entry – I think this gets the intention across well, and makes it clear what the user needs to do 👍
src/components/date-input/README.njk
Outdated
| @@ -55,7 +55,7 @@ | |||
| text: 'No' | |||
| }, | |||
| { | |||
| text: 'Optional name. This is used to compose the name attribute for each item.' | |||
| text: 'Optional prefix. This is used to prefix each `item.name`.' | |||
There was a problem hiding this comment.
I wonder if it's worth mentioning that they'll be joined using "-"?
There was a problem hiding this comment.
Done 👍 I thought initially about adding it but it felt like too much about the implementation. But it's probably useful information.
hannalaakso
force-pushed
the
amend-name-for-date-input-api
branch
from
3c9dba0
to
7f3af3d
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-984
hannalaakso
force-pushed
the
amend-name-for-date-input-api
branch
from
7f3af3d
to
c146193
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
nameargument on the date-input component acts as a prefix for each input's name, but this behaviour is not clear or consistent with how we usenamein other components.This PR renames it to
namePrefix. This is consistent with other components (like checkboxes and radios) which use the nameidPrefixto explain similar functionality.Fixes #909
https://trello.com/c/CFN5bvev/1392-2-behaviour-of-date-inputs-name-argument-is-not-clear