Skip to content

feat(docs): use babel-standalone in playground/v-play to support IE #2286

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

Merged
merged 71 commits into from
Dec 14, 2018

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Dec 12, 2018

Description of Pull Request:

Use the Babel standalone compiler to compile v-play examples and playground user supplied code, to allow ES6 support on older browsers (mainly IE)

Many of the documentation live examples do not work in IE 11, nor does ES6-ish code in the Playground.

Example (which should show the alert live example above the example code):

image

As a bonus of using babel, JavaScript compile errors provide better debugging (i.e line numbers, etc) in the Playground log:
image

Also adds overflow-x: auto to all live rendered examples. Fixes #1816

Todo:

  • playground page (play.vue)
  • v-play directive
  • make async/lazy load of babel-standalone
  • Figure out why polyfills (babel-polyfill / core-js) is not working in IE 11 (specifically the WeakSet polyfill)
  • Minor style adjustments

PR checklist:

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement to an existing feature
  • ARIA accessibility
  • Documentation update
  • Other, please describe: Docs site

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. fixes #xxxx[,#xxxx], where "xxxx" is the issue number)
  • The PR should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • PR titles should following the Conventional Commits naming convention (i.e. "fix(alert): not alerting during SSR render", "docs(badge): Updated pill examples, fix typos", "chore: fix typo in docs", etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (does it affect screen reader users or keyboard only users? clickable items should be in the tab index, etc)

If adding a new feature, or changing the functionality of an existing feature, the PR's description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@codecov
Copy link

codecov bot commented Dec 12, 2018

Codecov Report

Merging #2286 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #2286   +/-   ##
=======================================
  Coverage   66.55%   66.55%           
=======================================
  Files         162      162           
  Lines        3169     3169           
  Branches      879      879           
=======================================
  Hits         2109     2109           
  Misses        779      779           
  Partials      281      281

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fdf5ad7...b95ba83. Read the comment docs.

@tmorehouse
Copy link
Member Author

All live examples are now working in IE 11 :)

image

@tmorehouse tmorehouse requested a review from pi0 December 14, 2018 02:20
@tmorehouse
Copy link
Member Author

tmorehouse commented Dec 14, 2018

babel-standalone is imported lazily, which can make the first docs page shown with v-play to have a slight delay before the live examples are shown. Once loaded, switch pages is fast.

@tmorehouse tmorehouse mentioned this pull request Dec 14, 2018
89 tasks
@tmorehouse
Copy link
Member Author

tmorehouse commented Dec 14, 2018

Includes a few style fixes, including overflow-x: scroll on class .vue-example when viewing on small screens. Addresses Issue #1816

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs page is not optimized for mobile click
3 participants