Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: use named imports in javascript documentation #11497

Merged
merged 1 commit into from
Sep 9, 2018

Conversation

ncoden
Copy link
Contributor

@ncoden ncoden commented Sep 9, 2018

Description

Default imports were removed from plugins in #11445. This pull request use named import for the "direct import" fallback in the JavaScript tree-shaking documentation, instead of default imports.

Types of changes

  • Documentation
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (anything that would change an existing functionality)
  • Maintenance (refactor, code cleaning, development tools...)

Checklist

  • I have read and follow the CONTRIBUTING.md document.
  • The pull request title and template are correctly filled.
  • The pull request targets the right branch (develop or develop-v...).
  • My commits are correctly titled and contain all relevant information.
  • I have updated the documentation accordingly to my changes (if relevant).
  • I have added tests to cover my changes (if relevant).

import Dropdown from 'foundation-sites/js/foundation.dropdown';
import DropdownMenu from 'foundation-sites/js/foundation.dropdownMenu';
import { Dropdown } from 'foundation-sites/js/foundation.dropdown';
import { DropdownMenu } from 'foundation-sites/js/foundation.dropdownMenu';
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks Good to me!

Copy link
Contributor

Choose a reason for hiding this comment

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

@IamManchanda IamManchanda merged commit 73dbea1 into foundation:develop Sep 9, 2018
ncoden added a commit to ncoden/foundation-sites that referenced this pull request Sep 10, 2018
…th for v6.5.0

c7a0b9c docs: use named import for javascript "direct import" fallback

Signed-off-by: Nicolas Coden <nicolas@ncoden.fr>
@ncoden ncoden mentioned this pull request Sep 10, 2018
10 tasks
ncoden added a commit to ncoden/foundation-sites that referenced this pull request Nov 22, 2018
Despite the previous attempts to make Foundation compatible with tree shaking (foundation#11445, foundation#11497 and foundation#11508), Foundation is used with side-effects (on jQuery) and cannot be considered as "without side-effects" for tree-shaking purposes.

This commit remove the "sideEffects: false" label and thus disable tree-shaking support, until the Foundation API and usage is changed to not implicitely rely on the global jQuery object.

Closes foundation#11586

Related to:
- foundation#11508
- foundation#11497
- foundation#11445
ncoden added a commit to ncoden/foundation-sites that referenced this pull request Nov 22, 2018
Despite the previous attempts to make Foundation compatible with tree shaking (foundation#11445, foundation#11497 and foundation#11508), Foundation is used with side-effects (on jQuery) and cannot be considered as "without side-effects" for tree-shaking purposes.

This commit remove the "sideEffects: false" label and thus disable tree-shaking support, until the Foundation API and usage is changed to not implicitely rely on the global jQuery object.

Closes foundation#11586

Related to:
- foundation#11508
- foundation#11497
- foundation#11445
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants