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.

Sign up for GitHub

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

Jump to bottom

fix: OPL separators on hidden items and edge cases #3136

Merged
merged 5 commits into from
Jan 20, 2023
Merged

fix: OPL separators on hidden items and edge cases #3136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
488ba6a
fix: OPL separators on hidden items and edge cases
eKoopmans Jan 6, 2023
0d15733
Fix separator visibility on skeleton
eKoopmans Jan 19, 2023
c0359b8
Updating Visual Diff Goldens (#3185)
github-actions[bot] Jan 19, 2023
e5f5bb0
Remove redundant CSS variable
eKoopmans Jan 19, 2023
5a80687
Feedback: Assume slot can change
eKoopmans Jan 20, 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
13 changes: 13 additions & 0 deletions components/object-property-list/demo/object-property-list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,19 @@ <h2>Object Property List: Skeleton item count set</h2>
</template>
</d2l-demo-snippet>

<h2>Object Property List: Hidden items</h2>

<d2l-demo-snippet overflow-hidden>
<template>
<d2l-object-property-list>
<d2l-object-property-list-item text="Item 1"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 2 (Hidden)" hidden></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 3"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 4 (Hidden)" hidden></d2l-object-property-list-item>
</d2l-object-property-list>
</template>
</d2l-demo-snippet>

<h2>Object Property List: No external whitespace (still contains internal whitespace in the component renderers)</h2>

<d2l-demo-snippet overflow-hidden>
Expand Down
28 changes: 25 additions & 3 deletions components/object-property-list/object-property-list-item.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import { SkeletonMixin } from '../skeleton/skeleton-mixin.js';
export class ObjectPropertyListItem extends SkeletonMixin(LitElement) {
static get properties() {
return {
/**
* @ignore
*/
hidden: { type: Boolean },
/**
* Name of an optional icon to display
* @type {string}
Expand All @@ -21,6 +25,7 @@ export class ObjectPropertyListItem extends SkeletonMixin(LitElement) {
* @type {string}
*/
text: { type: String },
_showSeparator: { state: true },
};
}

Expand All @@ -29,12 +34,14 @@ export class ObjectPropertyListItem extends SkeletonMixin(LitElement) {
:host {
vertical-align: middle;
}
:host([hidden]) {
display: none;
}
d2l-icon {
height: 1.2857em; /* 18px desired height at main font size (14px), but using em to scale properly at smaller breakpoint. */
width: 1.2857em;
}
.separator {
display: var(--d2l-object-property-list-item-separator-display, inline);
margin: 0 -0.05rem; /* 10px desired margin, subtract 5px arbitrary whitespace and 6px whitespace inside bullet icon. */
}
.separator d2l-icon {
Expand All @@ -57,6 +64,11 @@ export class ObjectPropertyListItem extends SkeletonMixin(LitElement) {
`];
}

constructor() {
super();
this._showSeparator = true;
}

render() {
return html`
${this._renderIcon()}
Expand All @@ -65,17 +77,27 @@ export class ObjectPropertyListItem extends SkeletonMixin(LitElement) {
`;
}

updated(changedProperties) {
super.updated(changedProperties);
if (changedProperties.has('hidden')) this._onHidden();
}

_onHidden() {
/** Dispatched when the visibility of the item changes */
this.dispatchEvent(new CustomEvent('d2l-object-property-list-item-visibility-change', { bubbles: true, composed: true }));
}

_renderIcon() {
return this.icon && !this.skeleton ? html`<d2l-icon icon="${this.icon}" class="item-icon"></d2l-icon>` : nothing;
}

_renderSeparator() {
return html`
return this._showSeparator ? html`
<span class="separator">
<d2l-screen-reader-pause></d2l-screen-reader-pause>
<d2l-icon icon="tier1:bullet"></d2l-icon>
</span>
`;
` : nothing;
}

_renderText() {
Expand Down
26 changes: 22 additions & 4 deletions components/object-property-list/object-property-list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ class ObjectPropertyList extends LocalizeCoreElement(SkeletonMixin(LitElement))
:host([hidden]) {
display: none;
}
::slotted(:last-child), slot :last-child {
--d2l-object-property-list-item-separator-display: none;
}
::slotted([slot="status"]) {
display: none;
}
Expand All @@ -41,6 +38,13 @@ class ObjectPropertyList extends LocalizeCoreElement(SkeletonMixin(LitElement))
`];
}

firstUpdated() {
this.addEventListener('d2l-object-property-list-item-visibility-change', () => this._onItemsChanged());

const slot = this.shadowRoot.querySelector('slot:not([name])');
if (slot.childElementCount) this._setItemSeparatorVisibility(slot);
}

render() {
const slotContents = this.skeleton && this.skeletonCount > 0 ? [...Array(this.skeletonCount)].map(() => html`
<d2l-object-property-list-item text="${this.localize('components.object-property-list.item-placeholder-text')}" skeleton></d2l-object-property-list-item>
Expand All @@ -50,10 +54,24 @@ class ObjectPropertyList extends LocalizeCoreElement(SkeletonMixin(LitElement))
<div class="d2l-body-small">
<slot name="status"></slot>
<d2l-screen-reader-pause></d2l-screen-reader-pause>
<slot>${slotContents}</slot>
<slot @slotchange="${this._onItemsChanged}">${slotContents}</slot>
</div>
`;
}

_onItemsChanged(e) {
const slot = e?.target || this.shadowRoot.querySelector('slot:not([name])');
this._setItemSeparatorVisibility(slot);
}

_setItemSeparatorVisibility(slot) {
const slottedElements = slot.assignedElements();
const elements = slottedElements.length ? slottedElements : [ ...slot.children ];
const filtered = elements.filter(item => item.tagName?.toLowerCase().includes('d2l-object-property-list-') && !item.hidden);

const lastIndex = filtered.length - 1;
filtered.forEach((item, i) => item._showSeparator = (i !== lastIndex));
}
}

customElements.define('d2l-object-property-list', ObjectPropertyList);
37 changes: 34 additions & 3 deletions components/object-property-list/test/object-property-list.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import { aTimeout, expect, fixture, html } from '@open-wc/testing';
import { runConstructor } from '../../../tools/constructor-test-helper.js';

const validateSeparators = (elem, count) => {
const items = elem.querySelectorAll('d2l-object-property-list-item, d2l-object-property-list-item-link');
const items = elem.querySelectorAll('d2l-object-property-list-item:not([hidden]), d2l-object-property-list-item-link:not([hidden])');
expect(items.length).to.equal(count);
items.forEach((item, i) => {
const expectedDisplay = i === items.length - 1 ? 'none' : 'inline';
const shouldHaveSeparator = i !== items.length - 1;
const separator = item.shadowRoot.querySelector('.separator');
expect(window.getComputedStyle(separator).display).to.equal(expectedDisplay);
expect(!!separator).to.equal(shouldHaveSeparator);
});
};

Expand Down Expand Up @@ -65,6 +65,37 @@ describe('d2l-object-property-list', () => {
await aTimeout(); // Required for Webkit only.
validateSeparators(elem, 2);
});

it('should display correctly if status slot is after all items', async() => {
const elem = await fixture(html`
<d2l-object-property-list>
<d2l-object-property-list-item text="Example item 1"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Example item 2"></d2l-object-property-list-item>
<d2l-status-indicator slot="status" state="default" text="Status"></d2l-status-indicator>
</d2l-object-property-list>
`);
validateSeparators(elem, 2);
});

it('should respond to hidden items', async() => {
const elem = await fixture(html`
<d2l-object-property-list>
<d2l-status-indicator slot="status" state="default" text="Status"></d2l-status-indicator>
<d2l-object-property-list-item text="Example item 1"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Example item 2"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Example item 3" hidden id="hidden"></d2l-object-property-list-item>
</d2l-object-property-list>
`);
validateSeparators(elem, 2);

elem.querySelector('#hidden').removeAttribute('hidden');
await elem.updateComplete;
validateSeparators(elem, 3);

elem.querySelector('#hidden').setAttribute('hidden', '');
await elem.updateComplete;
validateSeparators(elem, 2);
});
});

});
9 changes: 9 additions & 0 deletions components/object-property-list/test/object-property-list.visual-diff.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,14 @@
</d2l-object-property-list>
</div>

<div class="visual-diff" id="hidden-items">
<d2l-object-property-list>
<d2l-object-property-list-item text="Item 1"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 2 (Hidden)" hidden></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 3"></d2l-object-property-list-item>
<d2l-object-property-list-item text="Item 4 (Hidden)" hidden></d2l-object-property-list-item>
</d2l-object-property-list>
</div>

</body>
</html>
1 change: 1 addition & 0 deletions components/object-property-list/test/object-property-list.visual-diff.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ describe('d2l-object-property-list', () => {
{ name: 'rtl', selector: '#rtl' },
{ name: 'list-skeleton', selector: '#list-skeleton' },
{ name: 'item-skeleton', selector: '#item-skeleton' },
{ name: 'hidden-items', selector: '#hidden-items' },
].forEach((info) => {
it(info.name, async function() {
const rect = await visualDiff.getRect(page, info.selector);
Expand Down
Binary file added ...nshots/ci/golden/object-property-list/d2l-object-property-list-hidden-items.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.