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

Addition of floating UI helpers #344

Merged
merged 26 commits into from
Jan 5, 2023
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
8cca2d3
Add necessary packages
brenner-company Nov 17, 2022
3ff840b
Add floating-ui modifier
brenner-company Nov 17, 2022
885d843
Add floating-ui component
brenner-company Nov 17, 2022
b0b7b56
Add floating-ui story (Storybook)
brenner-company Nov 17, 2022
d431fe7
Add exemplary styling for floating-ui component
brenner-company Nov 17, 2022
8659042
Fix static floater offset & unused variable
brenner-company Nov 17, 2022
ddd25f2
Reorder middleware options
brenner-company Nov 18, 2022
73fb754
Add middleware control & enable default values
brenner-company Nov 18, 2022
9d70b06
Remove middleware argument & restructure middleware settings (bugfix)
brenner-company Nov 21, 2022
d13af70
Fix floating-ui story (missing argument)
brenner-company Nov 21, 2022
1119b6d
Add test coverage for floating-ui modifier & component
brenner-company Nov 21, 2022
ac5f429
Relocate example scroller/floater structure & styling to dummy component
brenner-company Nov 21, 2022
33b7bf6
Disable linting error for a moment (before extending functionality)
brenner-company Nov 22, 2022
1edb52f
Merge branch 'development' into feature/addition-of-floating-ui-helpers
brenner-company Nov 24, 2022
86f7306
Add functionality for the example scroller component
brenner-company Dec 2, 2022
91825a1
Merge branch 'development' into feature/addition-of-floating-ui-helpers
brenner-company Dec 2, 2022
1438f26
Enable use of both negative & positive offset values for the arrow
brenner-company Dec 5, 2022
0526e4b
Convert floating-ui modifier to function-based modifier
brenner-company Dec 15, 2022
8ef07c7
Remove component version of floating-ui helper
brenner-company Jan 4, 2023
8c7390c
Remove floating-ui Storybook story
brenner-company Jan 4, 2023
827fb07
Delete re-export of floating-ui modifier
brenner-company Jan 4, 2023
062f607
Move floating-ui modifier to private folder & rename identifier
brenner-company Jan 4, 2023
170fbab
Adjust floating-ui modifier assertions
brenner-company Jan 4, 2023
9d5ced4
Move floating-ui modifier test to private folder, rename identifier &…
brenner-company Jan 4, 2023
740b87e
Remove dummy floater styling (not needed anymore)
brenner-company Jan 4, 2023
8842d20
Remove example scroller component & styling
brenner-company Jan 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions addon/components/au-floating-ui.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{{yield (hash
reference=this.referenceModifier
arrow=this.arrowModifier
floater=(if this.reference (
modifier
this.floaterModifier
this.reference
this.arrow
defaultPlacement=@defaultPlacement
options=@options
))
)}}
26 changes: 26 additions & 0 deletions addon/components/au-floating-ui.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';

import { modifier } from 'ember-modifier';
import AuFloatingUiModifier from '../modifiers/au-floating-ui';

export default class AuFloatingUiComponent extends Component {
@tracked reference = undefined;
@tracked arrow = undefined;

referenceModifier = modifier(
(element) => {
this.reference = element;
},
{ eager: false }
);

arrowModifier = modifier(
(element) => {
this.arrow = element;
},
{ eager: false }
);

floaterModifier = AuFloatingUiModifier;
}
161 changes: 161 additions & 0 deletions addon/modifiers/au-floating-ui.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
import { modifier } from 'ember-modifier';
import { assert } from '@ember/debug';

import {
autoUpdate,
computePosition,
flip,
hide,
offset,
arrow,
} from '@floating-ui/dom';

import { merge } from 'merge-anything';

export default modifier(
(
floatingElement,
[_referenceElement, _arrowElement],
{ defaultPlacement = 'bottom-start', options = {} }
) => {
const referenceElement =
typeof _referenceElement === 'string'
? document.querySelector(_referenceElement)
: _referenceElement;

const arrowElement =
typeof _arrowElement === 'string'
? document.querySelector(_arrowElement)
: _arrowElement;

const defaultOptions = {
floater: {
offset: 6,
},
arrow: {
offset: 4,
padding: 3,
position: 'min(15%, 12px)',
},
};
options = merge(defaultOptions, options);

assert(
`AuFloatingUI (modifier): No reference element was defined.`,
referenceElement instanceof HTMLElement
);

assert(
`AuFloatingUI (modifier): No floating element was defined.`,
floatingElement instanceof HTMLElement
);

assert(
`AuFloatingUI (modifier): The reference and floating elements cannot be the same element.`,
floatingElement !== _referenceElement
);

assert(
`AuFloatingUI (modifier): @placement must start with either 'bottom' or 'top'.`,
defaultPlacement.startsWith('bottom') ||
defaultPlacement.startsWith('top')
);

Object.assign(floatingElement.style, {
position: 'fixed',
top: '0',
left: '0',
});

let middleware = [
offset(options.floater.offset),
flip(),
hide({ strategy: 'referenceHidden' }),
hide({ strategy: 'escaped' }),
];

if (arrowElement) {
middleware.push(
arrow({
element: arrowElement,
padding: options.arrow.padding,
})
);
}

let update = async () => {
let { x, y, placement, middlewareData } = await computePosition(
referenceElement,
floatingElement,
{
middleware,
placement: defaultPlacement,
}
);

Object.assign(floatingElement.style, {
transform: `translate3d(${Math.round(x)}px, ${Math.round(y)}px, 0)`,
visibility: middlewareData.hide?.referenceHidden ? 'hidden' : 'visible',
});

if (middlewareData.arrow) {
const { x } = middlewareData.arrow;
const [side, alignment] = placement.split('-');
const isAligned = alignment != null;

const unsetSides = {
top: '',
bottom: '',
left: '',
right: '',
};

const mainSide = {
top: 'bottom',
bottom: 'top',
}[side];

const rotation = {
top: '180deg',
bottom: '0deg',
}[side];

const crossSide = {
'top-start': 'left',
'top-end': 'right',
'bottom-start': 'left',
'bottom-end': 'right',
}[placement];

Object.assign(arrowElement.style, {
...unsetSides,
transform: `rotate(${rotation})`,
});

if (isAligned) {
Object.assign(arrowElement.style, {
[crossSide]:
typeof options.arrow.position === 'string'
? options.arrow.position
: `${options.arrow.position}px`,
});
} else {
Object.assign(arrowElement.style, {
left: x != null ? `${x}px` : '',
});
}

Object.assign(arrowElement.style, {
[mainSide]: `${-options.arrow.offset}px`,
});
}
};

let cleanup = autoUpdate(referenceElement, floatingElement, update);

return () => {
cleanup();
};
},
{ eager: false }
);
1 change: 1 addition & 0 deletions app/components/au-floating-ui.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from '@appuniversum/ember-appuniversum/components/au-floating-ui';
1 change: 1 addition & 0 deletions app/modifiers/au-floating-ui.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from '@appuniversum/ember-appuniversum/modifiers/au-floating-ui';
26 changes: 26 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"dependencies": {
"@duetds/date-picker": "^1.4.0",
"@embroider/macros": "^1.9.0",
"@floating-ui/dom": "^1.0.4",
"@glimmer/component": "^1.1.2",
"@glimmer/tracking": "^1.1.2",
"@zestia/ember-auto-focus": "^4.2.0",
Expand All @@ -65,6 +66,7 @@
"ember-modifier": "^3.2.7",
"ember-named-blocks-polyfill": "^0.2.5",
"ember-test-selectors": "^6.0.0",
"merge-anything": "^5.1.3",
"tracked-toolbox": "^1.2.3"
},
"devDependencies": {
Expand Down
58 changes: 58 additions & 0 deletions stories/5-components/Helpers/AuFloatingUi.stories.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { hbs } from 'ember-cli-htmlbars';

export default {
title: 'Components/Helpers/AuFloatingUI',
argTypes: {
defaultPlacement: {
control: 'select',
options: [
'bottom-start',
'bottom',
'bottom-end',
'top-start',
'top',
'top-end',
],
description: 'Set the default placement of the floater',
},
options: {
control: 'object',
description: 'Set general options of the floater & arrow',
defaultValue: {},
},
},
parameters: {
layout: 'padded',
},
};

const Template = (args) => ({
template: hbs`
<AuExampleScroller>
<AuFloatingUi @defaultPlacement={{this.defaultPlacement}} @options={{this.options}} as |floatingUI|>
<AuButton
{{floatingUI.reference}}
@skin="primary"
@text="Reference"
>
Reference
</AuButton>
<div
{{floatingUI.floater}}
class="au-d-example-floater"
>
<div
{{floatingUI.arrow}}
class="au-d-example-floater-arrow"
></div>
<div class="au-d-example-floater-content">
<strong>Floater</strong><br/>
Lorem ipsum dolor sit amet
</div>
</div>
</AuFloatingUi>
</AuExampleScroller>`,
context: args,
});

export const Component = Template.bind();
5 changes: 5 additions & 0 deletions tests/dummy/app/components/au-example-scroller.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div {{this.exampleScrollerModifier}} class="au-d-example-scroller">
<div class="au-d-example-scroller-spacer">
{{yield}}
</div>
</div>
31 changes: 31 additions & 0 deletions tests/dummy/app/components/au-example-scroller.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import Component from '@glimmer/component';
import { modifier } from 'ember-modifier';

export default class AuExampleScroller extends Component {
exampleScrollerModifier = modifier(
(element) => {
const child = element.children[0];

const scrollerDimensions = {
width: element.offsetWidth,
height: element.offsetHeight,
};

const childDimensions = {
width: child.offsetWidth,
height: child.offsetHeight,
};

if (childDimensions.width > scrollerDimensions.width) {
element.scrollLeft =
(childDimensions.width - scrollerDimensions.width) / 2;
}

if (childDimensions.height > scrollerDimensions.height) {
element.scrollTop =
(childDimensions.height - scrollerDimensions.height) / 2;
}
},
{ eager: false }
);
}
18 changes: 18 additions & 0 deletions tests/dummy/app/styles/_d-example-floater.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.au-d-example-floater {
background-color: var(--au-gray-1000);
border-radius: var(--au-radius);
}

.au-d-example-floater-arrow {
position: absolute;
width: 0;
height: 0;
border-style: solid;
border-width: 0 4px 4px 4px;
border-color: transparent transparent var(--au-gray-1000) transparent;
}

.au-d-example-floater-content {
padding: .8rem 1.2rem;
color: var(--au-white);
}
Loading