Skip to content
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

Better selection button docs #350

Merged
merged 1 commit into from
Nov 22, 2016
Merged

Conversation

robinwhittleton
Copy link
Contributor

The documentation for selection buttons was in a pretty bad state. This tidies the code examples and attempts to do a much better job at explaining how delegated eventing for selection buttons works.

The documentation for selection buttons was in a pretty bad state. This tidies the code examples and attempts to do a much better job at explaining how delegated eventing for selection buttons works.
Copy link

@abbott567 abbott567 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've checked the changes and implemented the code as suggested to test it. It is working fine for me.

@gemmaleigh
Copy link
Contributor

Thanks @robinwhittleton & @abbott567!

@gemmaleigh gemmaleigh merged commit 77d847e into master Nov 22, 2016
@gemmaleigh gemmaleigh deleted the better-selection-button-docs branch November 22, 2016 10:51
robinwhittleton pushed a commit that referenced this pull request Nov 22, 2016
- Fix role="button" click shim (PR #347)
- Make font variables lowercase (PR #348)
- Update selection button documentation (PR #350)
@robinwhittleton robinwhittleton mentioned this pull request Nov 22, 2016
gemmaleigh added a commit to alphagov/govuk-prototype-kit that referenced this pull request Nov 22, 2016
https://raw.githubusercontent.com/alphagov/govuk_frontend_toolkit/master
/CHANGELOG.md

# 5.0.1

- Fix role="button" click shim ([PR
#347](alphagov/govuk_frontend_toolkit#347))
- Make font variables lowercase ([PR
#348](alphagov/govuk_frontend_toolkit#348))
- Update selection button documentation ([PR
#350](alphagov/govuk_frontend_toolkit#350))
gemmaleigh added a commit to alphagov/govuk_elements that referenced this pull request Nov 22, 2016
Update govuk_frontend_toolkit to 5.0.1
https://raw.githubusercontent.com/alphagov/govuk_frontend_toolkit/master
/CHANGELOG.md

# 5.0.1

- Fix role="button" click shim ([PR
#347](alphagov/govuk_frontend_toolkit#347))
- Make font variables lowercase ([PR
#348](alphagov/govuk_frontend_toolkit#348))
- Update selection button documentation ([PR
#350](alphagov/govuk_frontend_toolkit#350))
Guntrisoft added a commit to guidance-guarantee-programme/pension_guidance that referenced this pull request Dec 2, 2016
- Removed phase-banner scss file as no longer needed

Full list of changes:

SelectionButtons will add a class to the label with the type of the child input
alphagov/govuk_frontend_toolkit#317

Add GOVUK.ShowHideContent JavaScript to support showing and hiding content, toggled by radio buttons and checkboxes
alphagov/govuk_frontend_toolkit#315

Fix error in IE - remove trailing comma from shimLinksWithButtonRole JavaScript
alphagov/govuk_frontend_toolkit#323

Remove unnecessary print font fallback that causes regression downstream
alphagov/govuk_frontend_toolkit#328

Update tooling to use npm script rather than grunt-shell
alphagov/govuk_frontend_toolkit#327

For smaller screens (<768px) ensure that the GOVUK.StickAtTopWhenScrolling JS "unsticks" the element which was previously "stuck" (by removing both the class which sets fixed positioning and the shim).
alphagov/govuk_frontend_toolkit#329

Lint codebase using standard
alphagov/govuk_frontend_toolkit#334

Add semicolons at the start of IIFE's
alphagov/govuk_frontend_toolkit#339

Removal of external link styles and icons, if you are using the external-link-* mixins you will need to remove them from your codebase
alphagov/govuk_frontend_toolkit#293

Correct spelling of the 'accordion' icon, you will need to check for the incorrect spelling 'accordian' and update if you are using this icon
alphagov/govuk_frontend_toolkit#345

Amend GOVUK.StickAtTopWhenScrolling to resize the sticky element and shim when the .js-sticky-resize class is set
alphagov/govuk_frontend_toolkit#343

Allow custom options in GOVUK.analytics.trackPageview
alphagov/govuk_frontend_toolkit#332

Fix role="button" click shim
alphagov/govuk_frontend_toolkit#347

Make font variables lowercase
alphagov/govuk_frontend_toolkit#348

Update selection button documentation
alphagov/govuk_frontend_toolkit#350

Change colour used in phase tags to govuk-blue
alphagov/govuk_frontend_toolkit#353
Guntrisoft added a commit to guidance-guarantee-programme/pension_guidance that referenced this pull request Dec 2, 2016
- Removed phase-banner scss file as no longer needed

Full list of changes:

SelectionButtons will add a class to the label with the type of the child input
alphagov/govuk_frontend_toolkit#317

Add GOVUK.ShowHideContent JavaScript to support showing and hiding content, toggled by radio buttons and checkboxes
alphagov/govuk_frontend_toolkit#315

Fix error in IE - remove trailing comma from shimLinksWithButtonRole JavaScript
alphagov/govuk_frontend_toolkit#323

Remove unnecessary print font fallback that causes regression downstream
alphagov/govuk_frontend_toolkit#328

Update tooling to use npm script rather than grunt-shell
alphagov/govuk_frontend_toolkit#327

For smaller screens (<768px) ensure that the GOVUK.StickAtTopWhenScrolling JS "unsticks" the element which was previously "stuck" (by removing both the class which sets fixed positioning and the shim).
alphagov/govuk_frontend_toolkit#329

Lint codebase using standard
alphagov/govuk_frontend_toolkit#334

Add semicolons at the start of IIFE's
alphagov/govuk_frontend_toolkit#339

Removal of external link styles and icons, if you are using the external-link-* mixins you will need to remove them from your codebase
alphagov/govuk_frontend_toolkit#293

Correct spelling of the 'accordion' icon, you will need to check for the incorrect spelling 'accordian' and update if you are using this icon
alphagov/govuk_frontend_toolkit#345

Amend GOVUK.StickAtTopWhenScrolling to resize the sticky element and shim when the .js-sticky-resize class is set
alphagov/govuk_frontend_toolkit#343

Allow custom options in GOVUK.analytics.trackPageview
alphagov/govuk_frontend_toolkit#332

Fix role="button" click shim
alphagov/govuk_frontend_toolkit#347

Make font variables lowercase
alphagov/govuk_frontend_toolkit#348

Update selection button documentation
alphagov/govuk_frontend_toolkit#350

Change colour used in phase tags to govuk-blue
alphagov/govuk_frontend_toolkit#353
paulmsmith pushed a commit to dwp/pyca-prototype that referenced this pull request May 2, 2017
* adds addtional step for users to run npm install post updating via git

* Replace encrypted GitHub token

This updates the environment variable in the config to enable
deployment via Travis CI.

* change node version from 4 to 6

* Setting up a very simple test suite to check the server and build tasks run across nodejs 4, 5 & 6

* make mocha exit properly

* As npm test runs gulp test, remove this from travis.yml

* Simplify the sanity test check

App doesn't need to listen in the test script as supertest accepts the
app variable and handles the listening and un-listening itself.

This also removes the needs for the after block to stop the server.

* moved devdependencies to fix heroku

* Update govuk-elements-sass to 2.2.0

This release includes the custom radio button and checkbox styles.

https://github.com/alphagov/govuk_elements/blob/master/CHANGELOG.md#220

* Update readme to point to docs app

* Remove console log for the file path

This can be seen when viewing the docs app locally.

* v5.0.0

* Update govuk_frontend_toolkit to 5.0.1

https://raw.githubusercontent.com/alphagov/govuk_frontend_toolkit/master
/CHANGELOG.md

# 5.0.1

- Fix role="button" click shim ([PR
#347](alphagov/govuk_frontend_toolkit#347))
- Make font variables lowercase ([PR
#348](alphagov/govuk_frontend_toolkit#348))
- Update selection button documentation ([PR
#350](alphagov/govuk_frontend_toolkit#350))

* Use new font stack reference for unbranded templates

govuk_frontend_toolkit v5.0.1 lowercases the font stack names.

* google analytics

* only add google analytics in promomode

* Move analytics to separate include and use env variable

* Update ‘Back’ link URL

* Bump govuk-elements-sass to 2.2.1

This makes the phase tag in the phase banner $govuk-blue.

As the phase banner is now the same for both alpha and beta banners,
change the phase banner includes to use the recommended class
.phase-banner.

* Set travis to update the latest release branch after deployment

It looks like Travis is deploying the latest-release branch to Heroku.

Let’s move the script that checks for a version tag to after_deploy, in
the hope that it won’t affect the deployment of master to Heroku on a
successful build.

* Fix the "back" link to tutorials and examples

* Bump govuk template to 0.19.2

# 0.19.2

- Increase skiplink colour contrast ([PR
#263](alphagov/govuk_template#263))

# 0.19.1

- Have focus outline appear outside of element rather than covering it
in Safari and Chrome ([PR
#259](alphagov/govuk_template#259))

* Bump standard to current version

And fix reported issues: just spacing.

* Bump toolkit and nunjucks to latest versions

* Remove some unused packages

- consolidate was added to help replace mu2 for mustache rendering
- hogan.js was also in there for mustache rendering

* v5.0.1

- #330 Update GOV.UK toolkit and StandardJS to latest
- #328 Update GOV.UK template to latest
- #324 Fix the example question page’s back link

* use app.locals instead of app.use

* add git step to heroku guide

* Remove full stops from headings

* fix css sourcemaps

* Remove the title attribute

To match the change made to GOV.UK elements: alphagov/govuk_elements#389

* removing links to route.js and update path and file names in branching.html

* Prevent asking users to authenticate twice

This solves the problem with prototypes asking for username/password
twice.

The problem is caused by the ordering in the middleware.

When a user types in the URL for a prototype like
http://govuk-tagging.herokuapp.com they're asked for a
username/password first (via `utils.basicAuth`).

After filling that in they'll be able to "proceed" to the next step,
which redirects them to the `https://` version (via
`utils.forceHttps`).

Because the auth isn't shared between `http` and `https` version, they
are not authenticated anymore and have to enter their username/password
again.

Validated with https://test-prevent-double-auth.herokuapp.com/

* add override service name example

* add comment

* fix docs page

* bump gulp-sass to increase node-sass dependency to enable it to work with node 6 on linux

* add test for docs page

* allow search indexing in promo mode

* v5.1.0

* fix download link

* fix docs links

* Updating gulp-sass to 3.1.0

This is the latest version of gulp-sass.
https://www.npmjs.com/package/gulp-sass

* Bump govuk_frontend_toolkit to 5.1.1

# 5.1.1

- Update the alpha, beta and discovery colours to $govuk-blue to match
the updated phase banner ([PR
#370](alphagov/govuk_frontend_toolkit#370))
- Fix radio button show/hide behaviour when used outside a form ([PR
#375](alphagov/govuk_frontend_toolkit#375))
- Fix a "Stick at top when scrolling" component bug related to scroll
anchoring in Chrome 56+ ([PR
#376](alphagov/govuk_frontend_toolkit#376))
- Minor travis fixes ([PR
#373](alphagov/govuk_frontend_toolkit#373))

# 5.1.0

- Allow custom options when tracking events ([PR
#365](alphagov/govuk_frontend_toolkit#365))

# 5.0.3

- Change HMRC and DEFRA text colours for improved contrast ([PR
#368](alphagov/govuk_frontend_toolkit#368))

* formatting, clarify use of terminal, fix numbering

* Update govuk-elements-sass to 3.0.1

Changelog for GOV.UK elements:
https://github.com/alphagov/govuk_elements/blob/master/CHANGELOG.md

Changelog for the GOV.UK frontend toolkit:
https://github.com/alphagov/govuk_frontend_toolkit/blob/master/CHANGELOG
.md

* Remove DEPRECATED selection-buttons.js

This is no longer required with the radios and checkboxes released in
govuk-elements-sass v3.0.0.

* Update the radio buttons and checkboxes example page

To use the new markup released in GOV.UK elements 3.0.0.

* Replace .block-label with .multiple-choice

Update examples of radio buttons and checkboxes.

Replace ‘.block-label` with `.multiple-choice` as the block-label class
no longer exists.

* Add a .form-section wrapper to examples

Increase the spacing between the radio button and checkbox examples.

* Mention requirement for show-hide-content.js

* Fix radios and checkbox example page

This had nested form elements, which was a mistake. Removing these.

* Add an example of the task list pattern

Add an example of the task list pattern to the docs. Link to it from
the tutorials and examples page.

* Replace em values with gutter variables

Use variables from the govuk_frontend_toolkit’s _measurements.scss file.

Also add a new variable for the spacing to the left of the task list.

* Use the phase tag mixin for the completed status

* Make the "completed" status uppercase

* Rename the task-list to "task-list-page"

* Added config to turn off browser sync

* Add SSH Key for Travis

* Combine scripts and move to a deploy provider

This works in the same way as govuk_elements.

Create a new file - create-release.sh, combining - create release tag
and update release branch, these are deleted.

* Add missing EOF

* To maintain consistency, in this commit I have:
- assigned config.useBrowserSync to a variable
- ran the toLowerCase method on the variable
- change the if statement to reflect the new variable

* add auto data store

* add clear data link to docs app

* only run autodata once, include JS in docs

* use 'data' hash in locals

* use new multiple-choice css, use hyphens in names

* store GET data

* seperate guidance and example pages, added h1s

* refactor checked function

* use list for vehicle features

* fix return to examples link

* refactored docs

* set cookie name and timeout, use crypto

* de-duplicate forceHttps

* Add template pages for content and questions

* Add new template pages to examples index

* v6.0.0

* attempted fix for radio auto stores

* attempted fix for radio auto stores
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants