Skip to content
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

fix(overlay): use esm build from popper and point through to types #996

Merged
merged 1 commit into from Nov 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -32,6 +32,7 @@ packages/**/spectrum-vars.json
packages/**/*.js.map
packages/**/*.d.ts
!packages/*/global.d.ts
!packages/*/local.d.ts
packages/*/*/*.d.ts
!test/global.d.ts
!packages/*/test/global.d.ts
Expand Down
7 changes: 0 additions & 7 deletions .storybook/preview.js
Expand Up @@ -12,13 +12,6 @@ import {
import '@spectrum-web-components/theme/sp-theme.js';
import '@spectrum-web-components/theme/src/themes.js';

// While https://github.com/open-wc/open-wc/issues/1210 and
// go https://github.com/popperjs/popper-core/issues/933 persist
// without an acceptable outcome, this allows the built storybook
// to function with `process.env.NODE_ENV`... :/
window.process = window.process || {};
window.process.env = window.process.env || {};
window.process.env.NODE_ENV = window.process.env.NODE_ENV || 'production';
window.__swc_hack_knobs__ = window.__swc_hack_knobs__ || {};

addDecorator(withA11y);
Expand Down
56 changes: 56 additions & 0 deletions packages/overlay/local.d.ts
@@ -0,0 +1,56 @@
/*
Copyright 2020 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

declare module '@popperjs/core/dist/esm/popper-lite.js' {
import {
popperGenerator,
defaultModifiers,
} from '@popperjs/core/lib/popper-lite';

export { popperGenerator, defaultModifiers };
}

declare module '@popperjs/core/dist/esm/types.js' {
import { Instance } from '@popperjs/core/lib/types.js';

export { Instance };
}

declare module '@popperjs/core/dist/esm/enums.js' {
import { Placement } from '@popperjs/core/lib/enums.js';

export { Placement };
}

declare module '@popperjs/core/dist/esm/modifiers/flip.js' {
import flip from '@popperjs/core/lib/modifiers/flip.js';

export default flip;
}

declare module '@popperjs/core/dist/esm/modifiers/preventOverflow.js' {
import preventOverflow from '@popperjs/core/lib/modifiers/preventOverflow.js';

export default preventOverflow;
}

declare module '@popperjs/core/dist/esm/modifiers/arrow.js' {
import arrow from '@popperjs/core/lib/modifiers/arrow.js';

export default arrow;
}

declare module '@popperjs/core/dist/esm/modifiers/offset.js' {
import offset from '@popperjs/core/lib/modifiers/offset.js';

export default offset;
}
16 changes: 9 additions & 7 deletions packages/overlay/src/popper.ts
Expand Up @@ -13,17 +13,19 @@ governing permissions and limitations under the License.
// Bundle only what we want from popper
// See: https://popper.js.org/docs#popper-lite-tree-shaking

// eslint-disable-next-line @typescript-eslint/triple-slash-reference
/// <reference path="../local.d.ts" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the weirdest part. Even though I could get this to connect via yarn tsc --build packages/overlay/tsconfig.json without this reference, I could never get yarn tsc --build packages/*/tsconfig.json, our standard usage, to work without this... 😞

import {
popperGenerator,
defaultModifiers,
} from '@popperjs/core/lib/popper-lite';
import type { Instance } from '@popperjs/core/lib/types';
import type { Placement } from '@popperjs/core/lib/enums';
} from '@popperjs/core/dist/esm/popper-lite.js';
import type { Instance } from '@popperjs/core/dist/esm/types.js';
import type { Placement } from '@popperjs/core/dist/esm/enums.js';

import flip from '@popperjs/core/lib/modifiers/flip.js';
import preventOverflow from '@popperjs/core/lib/modifiers/preventOverflow.js';
import arrow from '@popperjs/core/lib/modifiers/arrow.js';
import offset from '@popperjs/core/lib/modifiers/offset.js';
import flip from '@popperjs/core/dist/esm/modifiers/flip.js';
import preventOverflow from '@popperjs/core/dist/esm/modifiers/preventOverflow.js';
import arrow from '@popperjs/core/dist/esm/modifiers/arrow.js';
import offset from '@popperjs/core/dist/esm/modifiers/offset.js';
import { computeArrowRotateStyles } from './popper-arrow-rotate.js';
import maxSize from 'popper-max-size-modifier';
import { applyMaxSize } from './apply-max-size.js';
Expand Down
8 changes: 0 additions & 8 deletions projects/example-project-rollup/src/example-app.ts
Expand Up @@ -21,11 +21,3 @@ import '@spectrum-web-components/dropdown/sp-dropdown';
// import '@spectrum-web-components/dropdown/sync/sp-dropdown';
import '@spectrum-web-components/menu/sp-menu';
import '@spectrum-web-components/menu/sp-menu-item';

// While https://github.com/open-wc/open-wc/issues/1210 and
// go https://github.com/popperjs/popper-core/issues/933 persist
// without an acceptable outcome, this allows the built storybook
// to function with `process.env.NODE_ENV`... :/
window.process = window.process || {};
window.process.env = window.process.env || {};
window.process.env.NODE_ENV = window.process.env.NODE_ENV || 'production';