Skip to content
This repository has been archived by the owner on Nov 25, 2024. It is now read-only.

Internet Explorer compatibility fix; changelog; config options; callbacks #46

Merged
merged 16 commits into from
Oct 10, 2018

Conversation

nfreear
Copy link
Contributor

@nfreear nfreear commented Oct 5, 2018

Hi @timcoughlan,

There are a few different things on this branch (bad practice!). Some big changes:

  1. The tool displays an "incompatibility" message for all versions of Internet Explorer, with a suggestion to upgrade (tested in MSIE 9 primarily), Browser compatibility ... ES6 ... FileReader ...! #7;
  2. Initial release notes / CHANGELOG, with an invitation to run git tag -a ;), Need git-tags and release notes when we "npm publish" #45;
  3. More configuration options, all with defaults. See: src/config.js, More configuration options, defaults, optional callbacks #43;

As documented in the README, you can now make a very simple call:

<script>
  require('our-journey').app.run();
</script>

... Or a more complex one:

<script>
  require('our-journey').app.run({
    containerSelector: '#our-journey-tool'

    // Other options ...
  })
  // Returns a Promise.
  .then(function (value) {
    console.warn('Loaded', value);
  })
  .catch(function (error) {
    console.error('Error:', error);
  });
</script>

I hope this makes sense. Happy to talk you through it!

Yours,

Nick

nfreear added 14 commits October 1, 2018 22:10
* Executed on JS include, not in `require().app.run()`
* Fixed conflict ~ docs/activities.html
* @timcoughlan "activities information updated"
* .. Removed duplicate `help.html` and `helpstyle` stylesheet
* .. Plus, IET-OU#45 edits to changelog
* Note, '.min.js' file ignored by Git;
* .. Plus, move 'husky' to 'peerDependencies' [iet:10364720][ci skip]
@nfreear nfreear requested a review from timcoughlan October 8, 2018 10:00
@nfreear
Copy link
Contributor Author

nfreear commented Oct 8, 2018

Hi @timcoughlan,

I've been continuing to hack ... I've finished for now, honest!

  1. I've added a test.html, which use the new configuration options to auto-create a QR code (the QR code is useless — too big, but it shows the potential hopefully!), More configuration options, defaults, optional callbacks #43;
  2. Added the missing package-lock.json, Checklist / suggestions for making the repo. public #38;
  3. Removed duplicate help.html and helpstyle.css (kept the ones in /docs/);
  4. Tweaked the markup and CSS for the HTML site pages (replaced <br> with <p>; increased line-height etc.);
  5. Added a minify/ compress step to npm run build, with uglify-es — run npm install, Preparation for heavier load, customisation and similar #41;
  6. Moved lint to devDependencies and husky to peerDependencies;

Note, minification reduces the 94 kB Javascript to 66 kB:

  • dist/our-journey.js — Still in Git; and npm/ Unpkg.com;
  • dist/our-journey.min.js — Ignored/ not in Git; it IS in npm/ Unpkg.com;

Yours,

Nick

@timcoughlan timcoughlan merged commit e9a7472 into IET-OU:master Oct 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants