@react-md/divider - npm Package Compare versions

Comparing version 2.0.0-alpha.14 to 2.0.0-alpha.15

CHANGELOG.md

@@ -1,1 +0,59 @@
-# v2.0.0-alpha.0
+# v2.0.0
+
+## New Behavior and Features
+
+- the `ref` is now correctly passed to the DOM element
+- the `role` has been specifically set to `"separator"` by default
+- the vertical divider behavior now has "better" support with a new
+  `VerticalDivider` component
+- the dividers can now be configured using CSS variables for the
+  `background-color`, `size`, `inset`, `spacing`, `vertical-spacing`, and
+  `max-size`
+
+## Breaking Changes
+
+- only styling behavior
+
+### New SCSS Variables, Functions, and Mixins
+
+- `$rmd-divider-max-size: 100% !default` - The max size for a divider that can
+  be used to make all dividers centered if desired
+- `$rmd-divider-spacing: 0.25rem auto !default` - the amount of margin to apply
+  to a horizontal divider
+- `$rmd-divider-vertical-spacing: auto 0.25rem !default` - the amount of margin
+  to apply to a vertical divider
+- `$rmd-divider-inset: 4rem !default` - The amount of spacing to use as
+  `margin-left` for an inset divider. This will automatically be swapped to
+  `margin-right` for right-to-left languages
+- `$rmd-divider-background-color-on-light: rgba($rmd-black-base, 0.12) !default` -
+  The background color for a divider in light themes
+- `$rmd-divider-background-color-on-dark: rgba($rmd-white-base, 0.12) !default` -
+  The background color for a divider in dark themes
+- `$rmd-divider-background-color: if(rmd-theme-tone($rmd-theme-background) == light, $rmd-divider-background-color-on-light, $rmd-divider-background-color-on-dark) !default` -
+  the default background color for dividers
+- `@function rmd-divider-theme` - gets one of the theme values and validates
+  that the theme name is valid
+- `@function rmd-divider-theme-var` - gets one of the theme values as a css
+  variable with a fallback value and validates that the theme name is valid
+- `@mixin rmd-divider-theme` - applies one of the theme values to a css property
+  as a css variable
+- `@mixin rmd-divider-theme-update-var` - updates one of the theme values as a
+  css variable
+- `@mixin rmd-divider-border` - creates a divider for an element using border
+  styles
+- `@mixin rmd-divider` - a mixin to generate all the divider styles for a class
+  name selector
+
+### Renamed SCSS Variables, Functions, and Mixins
+
+- renamed `$md-divider-height` to `$rmd-divider-size`
+
+### Removed SCSS Variables Placeholders, and Mixins
+
+- removed `$md-divider-include-borders` since the border class names are no
+  longer included and the new `rmd-divider-border` mixin should be used instead
+- removed `react-md-divider-borders` since the border class names are no longer
+  provided by default
+- removed `react-md-theme-dividers` and `react-md-theme-divider-borders` since
+  this is now handled automatically or with the new
+  `rmd-divider-theme-update-var` mixin

package.json

 {
   "name": "@react-md/divider",
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.15",
   "description": "This package is used to create horizontal or vertical dividers in your application.",
@@ -38,4 +38,4 @@ "scripts": {
   "dependencies": {
-    "@react-md/theme": "^2.0.0-alpha.14",
-    "@react-md/utils": "^2.0.0-alpha.14",
+    "@react-md/theme": "^2.0.0-alpha.15",
+    "@react-md/utils": "^2.0.0-alpha.15",
     "classnames": "^2.2.6"
@@ -52,3 +52,3 @@ },
   },
-  "gitHead": "2c22440705bce3fb3cfc5876011e7b3df8be1c03"
+  "gitHead": "c20671308497530c59f6563eafd1914b55122b8c"
 }

README.md

@@ -28,4 +28,5 @@ # @react-md/divider
 You should check out the
-[full documentation](https://react-md.dev/packages/divider) for live examples
-and more customization information, but an example usage is shown below.
+[full documentation](https://react-md.dev/packages/divider/demos) for live
+examples and more customization information, but an example usage is shown
+below.
 
@@ -32,0 +33,0 @@ <!-- DOCS_REMOVE_END -->

No alert changes

Improved metrics

Number of package files

44

increased by2.33%

Lines of code

774

increased by7.65%

Number of lines in readme file

67

increased by1.52%

Worsened metrics

Total package byte prevSize

68200

decreased by-82.51%

Dependency changes

• Updated@react-md/theme@^2.0.0-alpha.15

• Updated@react-md/utils@^2.0.0-alpha.15