-
Notifications
You must be signed in to change notification settings - Fork 328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README and CHANGELOG for ES module bundle #3950
Conversation
packages/govuk-frontend/README.md
Outdated
@@ -46,21 +46,24 @@ To import add the below to your Sass file: | |||
|
|||
Some of the JavaScript included in GOV.UK Frontend improves the usability and | |||
accessibility of the components. You should make sure that you are importing and | |||
initialising Javascript in your application to ensure that all users can use it successfully. | |||
initialising JavaScript in your application to ensure that all users can use it successfully. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
initialising JavaScript in your application to ensure that all users can use it successfully. | |
initialising JavaScript in your application. This will ensure all users can use it successfully. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just 1 minor change suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @claireashworth, all sorted
dc0d0e0
to
1a4608c
Compare
Mind if I request a review from @36degrees @romaricpascal @domoscargin? Since we link to the advanced options I've assumed the default ES module bundle was enough [More details on importing JavaScript and advanced options](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#javascript) But do we need to specifically need to add:
|
I think it's OK to just include instructions for the default way we want folks to to use, but maybe we could highlight the advanced options more, like:
(but with better words 🤣 ) |
Ha, thanks. Any thoughts @claireashworth? |
Yup, highlighting where they can find more detailed info is better than too much information front loading. A slight tweak to wording could be: If you import JavaScript using a different method, you might need to make some changes. Refer to the detailed guidance on importing JavaScript. |
Thanks @claireashworth. Mind if I widen that link text to include "detailed guidance on"?
Pushed it up |
1a4608c
to
19fd5d3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This PR changes our documentation to use the ES module
govuk-frontend.min.js
bundle:all.js
with ES modulesThe previous default
all.js
becameall.bundle.js
in f8335d9 as part of: