18F / web-design-standards-drupal

A Drupal base theme that uses the U.S. Web Design System. (ARCHIVED)
Other
46 stars 12 forks source link

Determine how best to handle jQuery dependency #2

Open fureigh opened 8 years ago

fureigh commented 8 years ago

As of this writing, Drupal 8 includes jQuery v1.7. The current version of the USWDS uses jQuery v1.11.3.

jonraedeke commented 8 years ago

I'm thinking the best short term approach is to add documentation to the project page like Bootstrap. Forcing the upgrade by loading it as an external library would break some core and contrib js.

If we added it with theme, we should make a theme setting to opt out in case a contrib module is being use manage the upgrade.

AlexBrown-appnovation commented 8 years ago

I agree with @jonraedeke about including this in documentation.

However I like the way that the Aurora theme has decided to tackle this with their owned hosted github page with a list of suggested modules - one of which is jquery_update. In our case, maybe we have a section of the documentation called 'Required Modules'.

Aurora documentation: http://snugug.github.io/Aurora/

fureigh commented 8 years ago

Whoops, thought I'd replied to this earlier. Thanks very much for the examples!

For the Drupal 7 version, I like the idea of including jQuery v1.11.3 as a requirement in the documentation. Giving users the option to opt out would require also testing the USWDS against earlier versions of jQuery, which could get very brittle very quickly.

For Drupal 8, jQuery update has been added to core:

D8 ships with the latest, and the plan is to continue increasing the shipped version (with BC available) in further minor releases.

We'll therefore want to keep an eye on how closely new releases of the USWDS and D8 move in tandem (or don't).

kevwalsh commented 8 years ago

There's a jquery_update patch for v1.11.4, but we may need to defer this for d7 until it's in a stable release.

fureigh commented 8 years ago

:+1: Thanks for finding that, @kevwalsh!

brockfanning commented 7 years ago

I don't think this is an issue anymore, as I believe jquery is no longer a dependency in USWDS.