Skip to content

Conversation

@obulat
Copy link
Contributor

@obulat obulat commented Jan 24, 2021

Fixes

Fixes #279 by @obulat

Description

Currently, the Modals for the Help section in the Chooser are converted from markdown in the locales.json files to HTML using markdown-it package at runtime. This PR replaces markdown with HTML to improve bundle size. Modals are also moved to a separate component to improve code organization.

Technical details

This PR extracts help modals from the HelpSection component into a separate ChooserModal component.

Previously, we have introduced vue-simple-portal package to render the modals in a separate div at the end of the body to fix a rendering problem: without the portal, you could see the underlying text through the modal. With the introduction of AppModal component from Vue Vocabulary, this problem was solved, so this PR removes vue-simple-portal package.

This PR also removes markdown from the modals, replacing them with HTML instead.
These changes make the un-compressed chunk-vendors 100 KiB smaller:


File                                   Size                        Gzipped
Before:
dist\js\chunk-vendors.f5ee90ab.js    388.52 KiB                  126.59 KiB
After:
dist\js\chunk-vendors.32fb3bc7.js    286.91 KiB                   89.75 KiB

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from zackkrida January 24, 2021 15:47
@obulat obulat requested a review from a team as a code owner January 24, 2021 15:47
@obulat obulat requested review from kgodey and removed request for a team January 24, 2021 15:47
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Great to see the frontend bundle size reduction 👏

@zackkrida zackkrida merged commit cc9c74e into creativecommons:master Feb 1, 2021
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.

Large bundle size

2 participants