@vonage/vivid 3.0.0-next.43 → 3.0.0-next.46

package/README.md

@@ -1,52 +1,131 @@
-<div class="home-page-hero">
-  <a href="https://github.com/vonage/vivid-3">
-    <img src="/vivid-logo.svg" style="" alt="Vivid Logo" width="120">
-  </a>
-  <h1>Welcome to Vivid</h1>
-
-[![codecov][codecov-shield]][codecov-url]
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-[![Apache 2.0 License][license-shield]][license-url]
-
-
-  <h6>
-    Vonage's design system platform targeted to provide </br>incorporated, battery-charged web components.
-  </h6>
-  <a class="home-page-hero-docs-btn" href="https://vivid.deno.dev"><strong>Explore the docs</strong></a>
-  <div class="home-page-hero-docs-links">
-    <a href="https://github.com/Vonage/vivid-3/issues/new?assignees=&labels=&template=bug_report.md&title=">Report Bug</a>
-    <span>|</span>    
-    <a href="https://github.com/Vonage/vivid-3/issues/new?assignees=&labels=&template=feature_request.md&title=">Request Feature</a>
-  </div>
-</div>
-
-### Installation
-
-run:
+
+# Vivid UI
+
+Essential UI **web components** for building modern web applications, bound to provide a **safe**, **simple** and **intuitive** interface.
+
+<!-- ! TODO add visual - GIF or image reflecting an easy integration of vivid in code and page result -->
+![the Vivid logo](/assets/images/vivid-cover-wide.avif)
+
+## Installation
+
+To integrate Vivid components into your project, run:
 
 ```bash
-npm install @vonage/vivid
+npm install @vonage/vivid # or yarn add @vonage/vivid
 ```
 
-use:
+## Usage
+
+Import components in your project via [side effect imports](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#import_a_module_for_its_side_effects_only):
 
 ```js
 import '@vonage/vivid/button';
 ```
 
+And include in HTML:
+
 ```html
 <vwc-button label="Click me"></vwc-button>
 ```
 
+For a full list of components and API, explore the [components docs](https://vivid.deno.dev/components/accordion/) 📚.
+
+### Prerequisites
+
+The Vivid components library rely on a set of **core styles** to:
+
+- Be present in the DOM
+
+- Be shared across all components
+
+- Apply common design identities (such as colors, typography, spacing etc')
+
+- Ensure the components look as intended.
+
+As the task of loading css is not trivial, and may vary from project to project, this library does not provide any way to load the css. It is up to the author to load the css in the most appropriate manner for their project.
+
+To **include the styles**, css files must be loaded into the project from the `node_modules/@vonage/vivid/styles` folder.
+
+The folder contains the following files:
+
+- Fonts
+
+  - `fonts/spezia.css` - Loads the *Spezia* variable font and specifies its font face definition. *Spezia* is Vonage's branded font and is required by most Vivid components
+
+- Themes - only one theme can apply at a time. thus, only one is required to be loaded
+
+  - `themes/light.css` - Light theme
+
+  - `themes/dark.css` - Dark theme
+
+Note: scss users can simply [forward](https://sass-lang.com/documentation/at-rules/forward) the styles to their scss project:
+
+```css
+@forward 'node_modules/@vonage/vivid/styles/fonts/spezia';
+@forward 'node_modules/@vonage/vivid/styles/themes/light';
+```
+
+## Support
+
+This library is open source, developed and maintained by the [Vonage Vivid team](Vonage/vivid).
+
+For any questions, please open a [bug report](https://github.com/Vonage/vivid-3/issues/new?assignees=&labels=&template=bug_report.md&title=) or [feature request](https://github.com/Vonage/vivid-3/issues/new?assignees=&labels=&template=feature_request.md&title=).
+
 ## Roadmap
 
-[view components status](https://github.com/orgs/Vonage/projects/6)
+- View [components status](https://github.com/orgs/Vonage/projects/6)
+
+- [What's on our plate](https://github.com/orgs/Vonage/projects/3/views/7)
+
+- See the [open issues](https://github.com/vonage/vivid-3/issues) for a full list of proposed features (and known issues).
+
+We publish a *next* release on every successful merge to main, so you never need to wait for a new stable version to make use of any updates.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [npm page](https://www.npmjs.com/package/@vonage/vivid).
+
+## Authors
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
 
-Follow our API planning on the [Vivid project components' view](https://github.com/orgs/Vonage/projects/3/views/13)
+## License
 
-We publish a _next_ release on every successful merge to main, so you never need to wait for a new stable version to make use of any updates.
+This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details
 
-See the [open issues](https://github.com/vonage/vivid-3/issues) for a full list of proposed features (and known issues).
+<!-- ## Acknowledgments
+
+- Hat tip to anyone whose code was used
+- Inspiration
+- etc -->
+
+## Built With
+
+- [Fast](https://www.fast.design) - to extend element classes and compile code to native web components
+- [Typescript](https://www.typescriptlang.org) - for ergonomic and type-safe code
+- [Sass](https://sass-lang.com) - for styles authoring extensibility and consistency
+
+## Quickstart
+
+Global content delivery networks can help quickly integrate content within html pages, fetching content from an URL, skipping local builds entirely.
+Such practice is often used when working on POCs or reproduction environments.
+Tools like [UNPKG](https://unpkg.com), [jsDeliver](https://www.jsdelivr.com), [Skypack](https://www.skypack.dev) etc' are bound to deliver any content registered in the npm registry.
+
+The following snippet fully renders a Vivid button component
+
+```html
+<!-- import spezia font -->
+<link rel="stylesheet" href="https://unpkg.com/@vonage/vivid@next/styles/fonts/spezia.css">
+
+<!-- import light theme style tokens -->
+<link rel="stylesheet" href="https://unpkg.com/@vonage/vivid@next/styles/themes/light.css">
+
+<!-- import Vivid button component -->
+<script type="module" src="https://unpkg.com/@vonage/vivid@next/button/index.js"></script>
+
+<vwc-button label="Click me" appearance="filled" connotation="cta"></vwc-button>
+```

package/checkbox/index.js

@@ -166,10 +166,7 @@ const CheckboxTemplate = context => {
 const vividCheckbox = Checkbox.compose({
   baseName: 'checkbox',
   template: CheckboxTemplate,
-  styles: css_248z,
-  shadowOptions: {
-    delegatesFocus: true
-  }
+  styles: css_248z
 });
 designSystem.register(vividCheckbox());
 

package/index.js

@@ -13,13 +13,15 @@ export { v as vividElevation } from './shared/index2.js';
 export { vividFab } from './fab/index.js';
 export { vividIcon } from './icon/index.js';
 export { vividLayout } from './layout/index.js';
+export { vividMenu } from './menu/index.js';
 export { vividNote } from './note/index.js';
-export { vividPopup } from './popup/index.js';
+export { v as vividPopup } from './shared/index3.js';
 export { vividProgress } from './progress/index.js';
 export { vividProgressRing } from './progress-ring/index.js';
 export { vividSideDrawer } from './side-drawer/index.js';
-export { vividSidenav } from './sidenav/index.js';
-export { vividSidenavItem } from './sidenav-item/index.js';
+export { vividNav } from './nav/index.js';
+export { vividNavItem } from './nav-item/index.js';
+export { vividNavDisclosure } from './nav-disclosure/index.js';
 export { vividText } from './text/index.js';
 export { vividTextfield } from './text-field/index.js';
 export { vividTooltip } from './tooltip/index.js';

package/lib/components.d.ts

@@ -13,13 +13,15 @@ export * from './elevation';
 export * from './fab';
 export * from './icon';
 export * from './layout';
+export * from './menu';
 export * from './note';
 export * from './popup';
 export * from './progress';
 export * from './progress-ring';
 export * from './side-drawer';
-export * from './sidenav';
-export * from './sidenav-item';
+export * from './nav';
+export * from './nav-item';
+export * from './nav-disclosure';
 export * from './text';
 export * from './text-field';
 export * from './tooltip';

package/lib/menu/index.d.ts

@@ -0,0 +1,11 @@
+import '../popup';
+import { Menu } from './menu';
+export declare const vividMenu: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
+    baseName: string;
+    template: any;
+    styles: import("@microsoft/fast-element").ComposableStyles;
+}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
+    baseName: string;
+    template: any;
+    styles: import("@microsoft/fast-element").ComposableStyles;
+}, typeof Menu>;

package/lib/menu/menu.d.ts

@@ -0,0 +1,7 @@
+import { Menu as FastMenu } from '@microsoft/fast-foundation';
+import type { Placement } from '@floating-ui/dom';
+export declare class Menu extends FastMenu {
+    open: boolean;
+    placement?: Placement;
+    anchor?: string;
+}

package/lib/menu/menu.template.d.ts

@@ -0,0 +1,3 @@
+import { type ElementViewTemplate } from '@microsoft/fast-element';
+import type { ElementDefinitionContext, FoundationElementDefinition } from '@microsoft/fast-foundation';
+export declare const MenuTemplate: (context: ElementDefinitionContext, definition: FoundationElementDefinition) => ElementViewTemplate;

package/lib/nav/index.d.ts

@@ -0,0 +1,2 @@
+import type { FoundationElementDefinition } from '@microsoft/fast-foundation';
+export declare const vividNav: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<FoundationElementDefinition, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;

package/lib/{sidenav/sidenav.d.ts → nav/nav.d.ts}

@@ -1,3 +1,3 @@
 import { FoundationElement } from '@microsoft/fast-foundation';
-export declare class Sidenav extends FoundationElement {
+export declare class Nav extends FoundationElement {
 }

package/lib/nav/nav.template.d.ts

@@ -0,0 +1,4 @@
+import type { ViewTemplate } from '@microsoft/fast-element';
+import type { ElementDefinitionContext, FoundationElementDefinition } from '@microsoft/fast-foundation';
+import type { Nav } from './nav';
+export declare const NavTemplate: (context: ElementDefinitionContext, definition: FoundationElementDefinition) => ViewTemplate<Nav>;

package/lib/nav-disclosure/index.d.ts

@@ -0,0 +1,4 @@
+import '../icon';
+import '../focus';
+import type { FoundationElementDefinition } from '@microsoft/fast-foundation';
+export declare const vividNavDisclosure: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<FoundationElementDefinition, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;

package/lib/{sidenav-disclosure/sidenav-disclosure.d.ts → nav-disclosure/nav-disclosure.d.ts}

@@ -1,10 +1,10 @@
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { AffixIcon } from '../../shared/patterns/affix';
-export declare class SidenavDisclosure extends FoundationElement {
+export declare class NavDisclosure extends FoundationElement {
     #private;
     details: HTMLDetailsElement;
     label?: string;
     open: boolean;
 }
-export interface SidenavDisclosure extends AffixIcon {
+export interface NavDisclosure extends AffixIcon {
 }

package/lib/nav-disclosure/nav-disclosure.template.d.ts

@@ -0,0 +1,4 @@
+import type { ViewTemplate } from '@microsoft/fast-element';
+import type { ElementDefinitionContext, FoundationElementDefinition } from '@microsoft/fast-foundation';
+import type { NavDisclosure } from './nav-disclosure';
+export declare const NavDisclosureTemplate: (context: ElementDefinitionContext, definition: FoundationElementDefinition) => ViewTemplate<NavDisclosure>;

package/lib/{sidenav → nav-item}/index.d.ts

@@ -1,2 +1,4 @@
+import '../icon';
+import '../focus';
 import type { FoundationElementDefinition } from '@microsoft/fast-foundation';
-export declare const vividSidenav: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<FoundationElementDefinition, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;
+export declare const vividNavItem: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<FoundationElementDefinition, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;

package/lib/{sidenav-item/sidenav-item.d.ts → nav-item/nav-item.d.ts}

@@ -1,6 +1,6 @@
 import { AffixIcon } from '../../shared/patterns/affix';
 import { TextAnchor } from '../text-anchor/text-anchor';
-export declare class SidenavItem extends TextAnchor {
+export declare class NavItem extends TextAnchor {
 }
-export interface SidenavItem extends AffixIcon {
+export interface NavItem extends AffixIcon {
 }

package/lib/{sidenav/sidenav.template.d.ts → nav-item/nav-item.template.d.ts}

@@ -1,4 +1,4 @@
 import type { ViewTemplate } from '@microsoft/fast-element';
 import type { ElementDefinitionContext, FoundationElementDefinition } from '@microsoft/fast-foundation';
-import type { Sidenav } from './sidenav';
-export declare const SidenavTemplate: (context: ElementDefinitionContext, definition: FoundationElementDefinition) => ViewTemplate<Sidenav>;
+import type { NavItem } from './nav-item';
+export declare const NavItemTemplate: (context: ElementDefinitionContext, definition: FoundationElementDefinition) => ViewTemplate<NavItem>;