@vaadin/split-layout - npm Package Compare versions

Comparing version 22.0.0-beta1 to 22.0.0-beta2

package.json

 {
   "name": "@vaadin/split-layout",
-  "version": "22.0.0-beta1",
+  "version": "22.0.0-beta2",
   "publishConfig": {
@@ -37,6 +37,6 @@ "access": "public"
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "22.0.0-beta1",
-    "@vaadin/vaadin-lumo-styles": "22.0.0-beta1",
-    "@vaadin/vaadin-material-styles": "22.0.0-beta1",
-    "@vaadin/vaadin-themable-mixin": "22.0.0-beta1"
+    "@vaadin/component-base": "22.0.0-beta2",
+    "@vaadin/vaadin-lumo-styles": "22.0.0-beta2",
+    "@vaadin/vaadin-material-styles": "22.0.0-beta2",
+    "@vaadin/vaadin-themable-mixin": "22.0.0-beta2"
   },
@@ -48,3 +48,3 @@ "devDependencies": {
   },
-  "gitHead": "4cf8a9d0504994200c610e44b3676114fef49c1e"
+  "gitHead": "f13833683e6667f6ca6678452db14aa6b7eac4a4"
 }

README.md

@@ -1,11 +0,8 @@
-# <vaadin-split-layout>
+# @vaadin/split-layout
 
-[Live Demo ↗](https://vaadin.com/components/vaadin-split-layout/html-examples)
-|
-[API documentation ↗](https://vaadin.com/components/vaadin-split-layout/html-api)
+A web component with two content areas and a draggable split handle between them.
 
-[<vaadin-split-layout>](https://vaadin.com/components/vaadin-split-layout) is a Web Component implementing a split layout for two content elements with a draggable splitter between them, part of the [Vaadin components](https://vaadin.com/components).
+[Documentation + Live Demo ↗](https://vaadin.com/docs/latest/ds/components/split-layout)
 
 [![npm version](https://badgen.net/npm/v/@vaadin/split-layout)](https://www.npmjs.com/package/@vaadin/split-layout)
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-split-layout)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
@@ -26,38 +23,41 @@
 
-[<img src="https://raw.githubusercontent.com/vaadin/vaadin-split-layout/master/screenshot.png" width="616" alt="Screenshot of vaadin-split-layout">](https://vaadin.com/components/vaadin-split-layout)
+[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/split-layout/screenshot.png" width="616" alt="Screenshot of vaadin-split-layout">](https://vaadin.com/docs/latest/ds/components/split-layout)
 
 ## Installation
 
-Install `vaadin-split-layout`:
+Install the component:
 
 ```sh
-npm i @vaadin/split-layout --save
+npm i @vaadin/split-layout
 ```
 
-Once installed, import it in your application:
+Once installed, import the component in your application:
 
 ```js
-import '@vaadin/split-layout/vaadin-split-layout.js';
+import '@vaadin/split-layout';
 ```
 
-## Getting started
+## Themes
 
-Vaadin components use the Lumo theme by default.
+Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/ds/customization/using-themes), Lumo and Material.
+The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/split-layout/vaadin-split-layout.js) of the package uses the Lumo theme.
 
-To use the Material theme, import the correspondent file from the `theme/material` folder.
+To use the Material theme, import the component from the `theme/material` folder:
 
-## Entry points
+```js
+import '@vaadin/split-layout/theme/material/vaadin-split-layout.js';
+```
 
-- The component with the Lumo theme:
+You can also import the Lumo version of the component explicitly:
 
-  `theme/lumo/vaadin-split-layout.js`
+```js
+import '@vaadin/split-layout/theme/lumo/vaadin-split-layout.js';
+```
 
-- The component with the Material theme:
+Finally, you can import the un-themed component from the `src` folder to get a minimal starting point:
 
-  `theme/material/vaadin-split-layout.js`
+```js
+import '@vaadin/split-layout/src/vaadin-split-layout.js';
+```
 
-- Alias for `theme/lumo/vaadin-split-layout.js`:
-
-  `vaadin-split-layout.js`
-
 ## Contributing
@@ -71,2 +71,3 @@
 
-Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.
+Vaadin collects usage statistics at development time to improve this product.
+For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

src/vaadin-split-layout.js

@@ -6,7 +6,7 @@ /**
  */
-import { PolymerElement, html } from '@polymer/polymer/polymer-element.js';
+import { IronResizableBehavior } from '@polymer/iron-resizable-behavior/iron-resizable-behavior.js';
 import { mixinBehaviors } from '@polymer/polymer/lib/legacy/class.js';
 import { GestureEventListeners } from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
 import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
-import { IronResizableBehavior } from '@polymer/iron-resizable-behavior/iron-resizable-behavior.js';
+import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
@@ -13,0 +13,0 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';

theme/lumo/vaadin-split-layout-styles.js

@@ -1,2 +0,1 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-lumo-styles/color.js';
@@ -6,2 +5,3 @@ import '@vaadin/vaadin-lumo-styles/sizing.js';
 import '@vaadin/vaadin-lumo-styles/style.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
@@ -8,0 +8,0 @@ registerStyles(

theme/material/vaadin-split-layout-styles.js

@@ -1,3 +0,3 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-material-styles/color.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
@@ -4,0 +4,0 @@ registerStyles(

No alert changes

Improved metrics

Number of lines in readme file

72

increased by1.41%

Worsened metrics

Total package byte prevSize

35938

decreased by-0.15%

Dependency changes

• + Added@open-wc/dedupe-mixin@1.4.0(transitive)

• + Added@vaadin/component-base@22.0.0-beta2(transitive)

• + Added@vaadin/icon@22.0.0-beta2(transitive)

• + Added@vaadin/vaadin-lumo-styles@22.0.0-beta2(transitive)

• + Added@vaadin/vaadin-material-styles@22.0.0-beta2(transitive)

• + Added@vaadin/vaadin-themable-mixin@22.0.0-beta2(transitive)

• - Removed@vaadin/component-base@22.0.0-beta1(transitive)

• - Removed@vaadin/icon@22.0.0-beta1(transitive)

• - Removed@vaadin/vaadin-lumo-styles@22.0.0-beta1(transitive)

• - Removed@vaadin/vaadin-material-styles@22.0.0-beta1(transitive)

• - Removed@vaadin/vaadin-themable-mixin@22.0.0-beta1(transitive)

• Updated@vaadin/component-base@22.0.0-beta2

• Updated@vaadin/vaadin-lumo-styles@22.0.0-beta2

• Updated@vaadin/vaadin-material-styles@22.0.0-beta2

• Updated@vaadin/vaadin-themable-mixin@22.0.0-beta2