@nectary/components 0.8.0

package/radio-option/index.d.ts

@@ -0,0 +1,28 @@
+import type { TSinchElementReact } from '../types';
+import type { FocusEvent } from 'react';
+export declare const isRadioOptionElement: (element: EventTarget | Element | null) => element is TSinchRadioOptionElement;
+export declare type TSinchRadioOptionElement = HTMLElement & {
+    value: string;
+    checked: boolean;
+    disabled: boolean;
+    text: string;
+    focus(): void;
+    blur(): void;
+};
+export declare type TSinchRadioOptionReact = TSinchElementReact<TSinchRadioOptionElement> & {
+    value: string;
+    disabled?: boolean;
+    text: string;
+    onFocus?: (e: FocusEvent<TSinchRadioOptionElement>) => void;
+    onBlur?: (e: FocusEvent<TSinchRadioOptionElement>) => void;
+};
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            'sinch-radio-option': TSinchRadioOptionReact;
+        }
+    }
+    interface HTMLElementTagNameMap {
+        'sinch-radio-option': TSinchRadioOptionElement;
+    }
+}

package/radio-option/index.js

@@ -0,0 +1,134 @@
+import _classPrivateFieldGet from '@babel/runtime/helpers/classPrivateFieldGet';
+import _classPrivateFieldSet from '@babel/runtime/helpers/classPrivateFieldSet';
+
+var _$input, _$label, _onInput;
+
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+
+import { defineCustomElement, getAttribute, getBooleanAttribute, isAttrTrue, updateAttribute, updateBooleanAttribute } from '../utils';
+const templateHTML = '<style>:host{--sinch-color-radio-outer-circle:var(--sinch-color-transparent);--sinch-color-radio-background:var(--sinch-color-snow-100);--sinch-color-radio-border:var(--sinch-color-stormy-300);--sinch-color-radio-outer-circle-checked:var(--sinch-color-transparent);--sinch-color-radio-border-checked:var(--sinch-color-tropical-500);--sinch-color-radio-outer-circle-hover:var(--sinch-color-snow-500);--sinch-color-radio-border-hover:var(--sinch-color-stormy-300);--sinch-color-radio-outer-circle-hover-checked:var(--sinch-color-tropical-100);--sinch-color-radio-border-hover-checked:var(--sinch-color-tropical-500);--sinch-color-radio-outer-circle-focus:var(--sinch-color-snow-800);--sinch-color-radio-border-focus:var(--sinch-color-stormy-300);--sinch-color-radio-outer-circle-focus-checked:var(--sinch-color-tropical-200);--sinch-color-radio-border-focus-checked:var(--sinch-color-tropical-500);--sinch-color-radio-outer-circle-active:var(--sinch-color-stormy-100);--sinch-color-radio-border-active:var(--sinch-color-stormy-300);--sinch-color-radio-outer-circle-active-checked:var(--sinch-color-tropical-300);--sinch-color-radio-border-active-checked:var(--sinch-color-tropical-500);--sinch-color-radio-outer-circle-disabled:var(--sinch-color-transparent);--sinch-color-radio-border-disabled:var(--sinch-color-stormy-100);--sinch-color-radio-outer-circle-disabled-checked:var(--sinch-color-transparent);--sinch-color-radio-border-disabled-checked:var(--sinch-color-stormy-100);display:block;outline:0}#wrapper{display:flex;font:var(--sinch-font-body);height:32px;box-sizing:border-box;width:100%}#input{all:initial;display:block;width:32px;height:32px;cursor:pointer}#input:disabled{cursor:initial}#icon-container{position:relative;width:32px;height:32px}#input::before{content:"";position:absolute;top:0;left:0;width:32px;height:32px;border-radius:50%;pointer-events:none;background-color:var(--sinch-color-radio-outer-circle);transition:background-color .1s linear}#input::after{content:"";position:absolute;top:6px;left:6px;width:20px;height:20px;border-radius:50%;pointer-events:none;background-color:var(--sinch-color-radio-background);box-shadow:0 0 0 2px var(--sinch-color-radio-border) inset;transition:background-color .1s linear}#icon-knob{position:absolute;left:11px;top:11px;width:10px;height:10px;border-radius:50%;transition:opacity .1s linear;opacity:0%;background-color:var(--sinch-color-radio-border);pointer-events:none}@media (prefers-reduced-motion){#icon-knob,#input::after,#input::before{transition:none}}#label{align-self:center;flex:1;overflow:hidden;white-space:nowrap;text-overflow:ellipsis;padding-left:8px;color:var(--sinch-color-text-default)}:host([disabled]:not([disabled=false])) #label{color:var(--sinch-color-stormy-200)}#input:checked::before{background-color:var(--sinch-color-radio-outer-circle-checked)}#input:checked::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-checked) inset}#input:checked~#icon-knob{opacity:100%;background-color:var(--sinch-color-radio-border-checked)}#input:focus::before{background-color:var(--sinch-color-radio-outer-circle-focus)}#input:focus::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-focus) inset}#input:focus~#icon-knob{background-color:var(--sinch-color-radio-border-focus)}#input:hover::before{background-color:var(--sinch-color-radio-outer-circle-hover)}#input:hover::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-hover) inset}#input:hover~#icon-knob{background-color:var(--sinch-color-radio-border-hover)}#input:active::before{background-color:var(--sinch-color-radio-outer-circle-active)}#input:active::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-active) inset}#input:active~#icon-knob{background-color:var(--sinch-color-radio-border-active)}#input:disabled::before{background-color:var(--sinch-color-radio-outer-circle-disabled)}#input:disabled::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-disabled) inset}#input:disabled~#icon-knob{background-color:var(--sinch-color-radio-border-disabled)}#input:focus:checked::before{background-color:var(--sinch-color-radio-outer-circle-focus-checked)}#input:focus:checked::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-focus-checked) inset}#input:focus:checked~#icon-knob{opacity:100%;background-color:var(--sinch-color-radio-border-focus-checked)}#input:hover:checked::before{background-color:var(--sinch-color-radio-outer-circle-hover-checked)}#input:hover:checked::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-hover-checked) inset}#input:hover:checked~#icon-knob{opacity:100%;background-color:var(--sinch-color-radio-border-hover-checked)}#input:active:checked::before{background-color:var(--sinch-color-radio-outer-circle-active-checked)}#input:active:checked::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-active-checked) inset}#input:active:checked~#icon-knob{opacity:100%;background-color:var(--sinch-color-radio-border-active-checked)}#input:disabled:checked::before{background-color:var(--sinch-color-radio-outer-circle-disabled-checked)}#input:disabled:checked::after{box-shadow:0 0 0 2px var(--sinch-color-radio-border-disabled-checked) inset}#input:disabled:checked~#icon-knob{opacity:100%;background-color:var(--sinch-color-radio-border-disabled-checked)}</style><div id="wrapper"><div id="icon-container"><input id="input" type="radio"/><div id="icon-knob"></div></div><label for="input" id="label"></label></div>';
+export const isRadioOptionElement = element => {
+  return element instanceof Element && element.tagName === 'SINCH-RADIO-OPTION';
+};
+const template = document.createElement('template');
+template.innerHTML = templateHTML;
+defineCustomElement('sinch-radio-option', (_$input = new WeakMap(), _$label = new WeakMap(), _onInput = new WeakMap(), class extends HTMLElement {
+  constructor() {
+    super();
+
+    _classPrivateFieldInitSpec(this, _$input, {
+      writable: true,
+      value: void 0
+    });
+
+    _classPrivateFieldInitSpec(this, _$label, {
+      writable: true,
+      value: void 0
+    });
+
+    _classPrivateFieldInitSpec(this, _onInput, {
+      writable: true,
+      value: e => {
+        e.stopPropagation();
+        _classPrivateFieldGet(this, _$input).checked = false;
+        this.dispatchEvent(new CustomEvent('change', {
+          bubbles: true,
+          detail: this.value
+        }));
+      }
+    });
+
+    const shadowRoot = this.attachShadow({
+      mode: 'production' === 'development' ? 'open' : 'closed',
+      delegatesFocus: true
+    });
+    shadowRoot.appendChild(template.content.cloneNode(true));
+
+    _classPrivateFieldSet(this, _$input, shadowRoot.querySelector('input'));
+
+    _classPrivateFieldSet(this, _$label, shadowRoot.querySelector('label'));
+  }
+
+  connectedCallback() {
+    _classPrivateFieldGet(this, _$input).addEventListener('input', _classPrivateFieldGet(this, _onInput));
+  }
+
+  disconnectedCallback() {
+    _classPrivateFieldGet(this, _$input).removeEventListener('input', _classPrivateFieldGet(this, _onInput));
+  }
+
+  static get observedAttributes() {
+    return ['checked', 'disabled', 'text', 'value'];
+  }
+
+  set checked(isChecked) {
+    updateBooleanAttribute(this, 'checked', isChecked);
+  }
+
+  get checked() {
+    return getBooleanAttribute(this, 'checked');
+  }
+
+  set value(value) {
+    updateAttribute(this, 'value', value);
+  }
+
+  get value() {
+    return getAttribute(this, 'value', '');
+  }
+
+  set disabled(isDisabled) {
+    updateBooleanAttribute(this, 'disabled', isDisabled);
+  }
+
+  get disabled() {
+    return getBooleanAttribute(this, 'disabled');
+  }
+
+  set text(value) {
+    updateAttribute(this, 'text', value);
+  }
+
+  get text() {
+    return getAttribute(this, 'text', '');
+  }
+
+  attributeChangedCallback(name, _, newVal) {
+    switch (name) {
+      case 'text':
+        {
+          _classPrivateFieldGet(this, _$label).textContent = newVal;
+          break;
+        }
+
+      case 'checked':
+        {
+          _classPrivateFieldGet(this, _$input).checked = isAttrTrue(newVal);
+          break;
+        }
+
+      case 'disabled':
+        {
+          _classPrivateFieldGet(this, _$input).disabled = isAttrTrue(newVal);
+          break;
+        }
+
+      case 'value':
+        {
+          _classPrivateFieldGet(this, _$input).value = newVal ?? '';
+          break;
+        }
+    }
+  }
+
+  focus() {
+    _classPrivateFieldGet(this, _$input).focus();
+  }
+
+  blur() {
+    _classPrivateFieldGet(this, _$input).blur();
+  }
+
+}));

package/readme.md

@@ -0,0 +1,172 @@
+# 🐝 Nectary
+
+Design System's framework-agnostic Component Library implementation.
+
+>Nectaries are specialized nectar-producing structures of the flower.
+
+>Bumblebees eat nectar and pollen made by flowers. The sugary nectar provides the bees with energy while the pollen provides them with protein.
+
+## Install
+
+Add the following line to `.npmrc` in the project root:
+
+```
+//registry.npmjs.org/:_authToken=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
+```
+
+Add the component library dependency to `package.json`:
+
+```
+npm install @sinch-engage/nectary
+# or
+yarn add @sinch-engage/nectary
+```
+
+⚠️ VPN is required.
+
+## Usage
+
+### Theme
+
+Import CSS file with [custom properties](./theme.css) (variables):
+
+```js
+import '@sinch-engage/nectary/theme.css'
+```
+
+Use color palette or custom font face:
+
+```css
+span {
+  color: var(--sinch-color-honey-700);
+}
+
+h2 {
+  font: var(--sinch-font-title-2);
+}
+```
+
+### Components
+
+Import component:
+
+```js
+import '@sinch-engage/nectary/button'
+```
+
+Use it in React/Vue/Angular/etc, for example:
+
+```jsx
+<sinch-button value="Click me" onClick={() => console.log('click')}></sinch-button>
+```
+
+⚠️ Note that it's not allowed to self-close custom element tags.
+
+## Testing
+
+If you are testing your application using Nectary components with Jest, you might run into some problems, as it does not work out of the box. Here are the common pitfalls and their solutions.
+
+### Example configuration
+
+jest.config.js
+
+```js
+/** @type {import("ts-jest/dist/types").InitialOptionsTsJest} */
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "jsdom",
+    moduleNameMapper: {
+        "\\.(css)$": "identity-obj-proxy"
+    },
+    transform: {
+        "^.+\\.(ts|tsx)?$": "ts-jest",
+        "^.+\\.(js|jsx)$": "babel-jest"
+    },
+    transformIgnorePatterns: [
+        "node_modules/(?!@nectary)"
+    ]
+}
+```
+
+babel.config.js
+
+```js
+module.exports = {presets: ['@babel/preset-env']}
+```
+
+### CSS
+
+If you already have a babel loader for CSS, you might not need this part. If you do not, you can use [identity-obj-proxy](https://www.npmjs.com/package/identity-obj-proxy) to mock your CSS imports:
+
+```
+npm install identity-obj-proxy
+# or
+yarn add identity-obj-proxy
+```
+
+Then add this part to your jest.config.js file:
+
+```
+    moduleNameMapper: {
+        "\\.(css)$": "identity-obj-proxy"
+    },
+```
+
+It lets Jest know how to mock the css imports in your codebase, like for example when you import the theme:
+
+```js
+import '@sinch-engage/nectary/theme.css'
+```
+
+This import should not throw an error now.
+
+### JS and TS
+
+You are going to need to install [babel-jest](https://www.npmjs.com/package/babel-jest) if it is not already done:
+
+```
+npm install babel-jest
+# or
+yarn add babel-jest
+```
+
+Then add this lines to your jest.config.js file:
+
+```
+    transform: {
+        "^.+\\.(ts|tsx)?$": "ts-jest", // if you are using Typescript and ts-jest
+        "^.+\\.(js|jsx)$": "babel-jest"
+    },
+    transformIgnorePatterns: [
+        "node_modules/(?!@nectary)"
+    ]
+```
+
+It is necessary to export the env preset in the babel.js.config file:
+
+```js
+module.exports = {presets: ['@babel/preset-env']}
+```
+
+If you import any component:
+
+```js
+import '@sinch-engage/nectary/input'
+```
+
+It should not throw the error: 
+
+```Jest encountered an unexpected token```
+
+## TODO
+
+- [x] [Storybook](https://saas.pages.sinch.com/engage/engage/) (VPN is required)
+- [x] Follow the WCAG 2.1 guidelines
+- [x] Tests
+  - [x] (in progress) Cross-browser Chromium/Firefox/WebKit visual regression tests
+  - [x] Cross-framework React/Vue/Angular tests 
+  - [x] a11y tests using [Axe](https://www.deque.com/axe/) library
+- [ ] CI/CD
+  - [x] Auto-publish on Git tag
+  - [x] Send message/changelog to Slack
+  - [ ] Provide unique Storybook preview link in PRs

package/select/index.d.ts

@@ -0,0 +1,37 @@
+import type { TSinchElementReact } from '../types';
+import type { FocusEvent, SyntheticEvent } from 'react';
+export declare type TSinchSelectElement = HTMLElement & {
+    value: string;
+    label: string;
+    placeholder: string | null;
+    optionalText: string | null;
+    invalidText: string | null;
+    additionalText: string | null;
+    disabled: boolean;
+    maxVisibleItems: number | null;
+    focus(): void;
+    blur(): void;
+};
+export declare type TSinchSelectReact = TSinchElementReact<TSinchSelectElement> & {
+    value: string;
+    label: string;
+    placeholder?: string;
+    optionalText?: string;
+    invalidText?: string;
+    additionalText?: string;
+    disabled?: boolean;
+    maxVisibleItems?: number;
+    onChange: (e: SyntheticEvent<TSinchSelectElement, CustomEvent<string>>) => void;
+    onFocus?: (e: FocusEvent<TSinchSelectElement>) => void;
+    onBlur?: (e: FocusEvent<TSinchSelectElement>) => void;
+};
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            'sinch-select': TSinchSelectReact;
+        }
+    }
+    interface HTMLElementTagNameMap {
+        'sinch-select': TSinchSelectElement;
+    }
+}