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

feat(creation-tunnel): introduce cc-zone-card and cc-zone-picker components #1154

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
213 changes: 213 additions & 0 deletions src/components/cc-zone-card/cc-zone-card.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
import { css, html, LitElement } from 'lit';
import { iconRemixCheckboxCircleFill as selectedIcon } from '../../assets/cc-remix.icons.js';
import { skeletonStyles } from '../../styles/skeleton.js';
import { i18n } from '../../translations/translation.js';
import '../cc-badge/cc-badge.js';
import '../cc-icon/cc-icon.js';
import '../cc-img/cc-img.js';

/**
* @typedef {import('./cc-zone-card.types.js').ZoneImage} ZoneImage
*/

/**
* A component displaying a card with relative zone information (name, code...)
*
* @cssdisplay flex
*/
export class CcZoneCard extends LitElement {
static get properties() {
return {
code: { type: String },
countryCode: { type: String, attribute: 'country-code' },
country: { type: String },
disabled: { type: Boolean, reflect: true },
flagUrl: { type: String },
Copy link
Contributor

Choose a reason for hiding this comment

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

fix: add attribute: 'flag-url''

images: { type: Array },
infra: { type: String },
Copy link
Contributor

Choose a reason for hiding this comment

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

question: property not used... is it really needed?

name: { type: String },
selected: { type: Boolean, reflect: true },
};
}

constructor() {
super();

/** @type {string} The zone code */
this.code = null;

/** @type {string} The country name */
this.country = null;

/** @type {string} The country code (e.g: FRA) */
this.countryCode = null;

/** @type {boolean} Whether the card should be disabled */
this.disabled = false;

/** @type {string} The url of the flag image */
this.flagUrl = null;

/** @type {ZoneImage[]} A list of images that will displayed in the footer */
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick: extra space

this.images = [];

/** @type {string} The infra name (e.g: clevercloud) */
this.infra = null;

/** @type {string} The name of the zone */
this.name = null;

/** @type {boolean} Whether the card should be selected */
this.selected = false;
}

render() {
return html`
<div class="title">
<div class="infra">${this.code}</div>
<div class="zone-name">${this.name}</div>
</div>
<cc-icon class="icon-selected" .icon="${selectedIcon}" size="lg"></cc-icon>
<div class="thumbnails">
${this.flagUrl
? html`
<cc-img
class="flag"
src=${this.flagUrl}
a11y-name="${i18n('cc-zone-card.alt.country-name', {
code: this.countryCode,
name: this.country,
})}"
></cc-img>
`
: ''}
${this.images.map((image) => html`<cc-img src="${image.url}" a11y-name="${image.alt}"></cc-img>`)}
</div>
`;
}

static get styles() {
return [
skeletonStyles,
Copy link
Contributor

Choose a reason for hiding this comment

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

fix: skeleton style is not used

// language=CSS
css`
:host {
border: 2px solid var(--cc-color-border-neutral);
border-radius: var(--cc-border-radius-default);
display: flex;
flex-direction: column;
overflow: hidden;
position: relative;
}

input {
height: 100%;
position: relative;
width: 100%;
}

:host .title {
flex: 1 1 auto;
}

:host .thumbnails {
flex: 0 0 auto;
}

:host(:hover:not([disabled])) {
border-color: var(--cc-color-border-neutral-hovered);
}

:host(:not([selected], [disabled])) {
cursor: pointer;
}

:host([selected]) {
border-color: var(--cc-color-bg-primary);
}

:host([selected]) .title .infra {
color: var(--cc-color-text-primary-strong);
}

:host([selected]) .title .zone-name {
color: var(--cc-color-text-primary-strongest);
}

:host([selected]) .icon-selected {
opacity: 1;
}

:host([selected]) .thumbnails {
background-color: var(--cc-color-bg-primary-weak);
}

:host([disabled]) {
border-color: var(--cc-color-border-neutral-disabled);
opacity: var(--cc-opacity-when-disabled);
}

:host([disabled]) .infra {
color: #fff;
}

:host([disabled]) .title .infra,
:host([disabled]) .title .zone-name {
opacity: var(--cc-opacity-when-disabled);
}

:host([disabled]) .thumbnails {
background-color: #fafafa;
}

:host([disabled]) .thumbnails cc-icon,
:host([disabled]) .thumbnails cc-img {
filter: grayscale(1);
opacity: var(--cc-opacity-when-disabled);
}

.title {
padding: 1em 1em 0.75em;
}

.infra {
color: var(--cc-color-text-weak);
font-size: 0.875em;
line-height: 1.125;
padding-inline-start: 0.125em;
}

.zone-name {
font-size: 1.5em;
line-height: 1.125;
}

.icon-selected {
--cc-icon-color: var(--cc-color-bg-primary);

opacity: 0;
position: absolute;
right: 0.5em;
top: 0.5em;
}

.thumbnails {
align-items: center;
background-color: var(--cc-color-bg-neutral);
display: inline-flex;
gap: 0.5em;
padding: 0.75em 1.125em;
}

.thumbnails > cc-img {
--cc-img-fit: contain;

height: 1.5em;
width: 1.5em;
}
`,
];
}
}

window.customElements.define('cc-zone-card', CcZoneCard);
95 changes: 95 additions & 0 deletions src/components/cc-zone-card/cc-zone-card.stories.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { getFlagUrl } from '../../lib/remote-assets.js';
import { makeStory } from '../../stories/lib/make-story.js';
import './cc-zone-card.js';

export default {
tags: ['autodocs'],
title: '🛠 Creation Tunnel/<cc-zone-card>',
component: 'cc-zone-card',
};

const cleverIcon = new URL('../../stories/assets/clevercloud.svg', import.meta.url);

const conf = {
component: 'cc-zone-card',
// language=CSS
css: ``,
};

const DEFAULT_ITEM = {
code: 'par',
name: 'Paris',
selected: false,
images: [{ url: cleverIcon, alt: 'infra' }],
flagUrl: getFlagUrl('FR'),
countryCode: 'FR',
country: 'France',
};
const LONG_CODE = {
code: 'very-very-very-very-very-very-very-long-code',
name: 'Zone',
selected: false,
images: [{ url: cleverIcon, alt: 'infra' }],
flagUrl: getFlagUrl('FR'),
countryCode: 'FR',
country: 'France',
};

const LONG_NAME = {
code: 'code',
name: 'very-very-very-very-very-very-very-long-name',
selected: false,
images: [{ url: cleverIcon, alt: 'infra' }],
flagUrl: getFlagUrl('FR'),
countryCode: 'FR',
country: 'France',
};

const LONG_CODE_AND_NAME = {
code: 'very-very-very-very-very-very-very-long-code',
name: 'very-very-very-very-very-very-very-long-name',
selected: false,
images: [{ url: cleverIcon, alt: 'infra' }],
flagUrl: getFlagUrl('FR'),
countryCode: 'FR',
country: 'France',
};

export const defaultStory = makeStory(conf, {
items: [DEFAULT_ITEM],
});

export const disabled = makeStory(conf, {
items: [{ ...DEFAULT_ITEM, disabled: true }],
});

export const selected = makeStory(conf, {
items: [{ ...DEFAULT_ITEM, selected: true }],
});

export const longCode = makeStory(conf, {
items: [
{ ...LONG_CODE, style: 'width: 10em' },
{ ...LONG_CODE, style: 'width: 20em' },
{ ...LONG_CODE, style: 'width: 30em' },
LONG_CODE,
],
});

export const longName = makeStory(conf, {
items: [
{ ...LONG_NAME, style: 'width: 10em' },
{ ...LONG_NAME, style: 'width: 20em' },
{ ...LONG_NAME, style: 'width: 30em' },
LONG_NAME,
],
});

export const longCodeAndLongName = makeStory(conf, {
items: [
{ ...LONG_CODE_AND_NAME, style: 'width: 10em' },
{ ...LONG_CODE_AND_NAME, style: 'width: 20em' },
{ ...LONG_CODE_AND_NAME, style: 'width: 30em' },
LONG_CODE_AND_NAME,
],
});
11 changes: 11 additions & 0 deletions src/components/cc-zone-card/cc-zone-card.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/* eslint-env node, mocha */

import { testAccessibility } from '../../../test/helpers/accessibility.js';
import { getStories } from '../../../test/helpers/get-stories.js';
import * as storiesModule from './cc-zone-card.stories.js';

const storiesToTest = getStories(storiesModule);

describe(`Component: ${storiesModule.default.component}`, function () {
testAccessibility(storiesToTest);
});
4 changes: 4 additions & 0 deletions src/components/cc-zone-card/cc-zone-card.types.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export interface ZoneImage {
url: string;
alt: string;
}
Loading
Loading