@amboss/design-system - npm Package Compare versions

Comparing version 0.6.0 to 0.7.0

build/src/components/Box/Box.d.ts

@@ -5,6 +5,12 @@ import React from "react";
     children: React.ReactNode[] | React.ReactNode;
-    /** specify [small screen padding, medium screen padding, large screen padding] or one padding for all screen sizes */
+    /** Represents both vertical and horizontal paddings. When used alone, vertical and horizontal paddings will have the same value.
+     * Use "vSpace" prop to override vertical padding value in case you want it different.
+     * specify [small screen padding, medium screen padding, large screen padding] or one padding for all screen sizes
+     * */
     space?: SpaceSizes | MQ<SpaceSizes>;
-    /** specify [small screen vertical padding, medium screen vertical padding, large screen vertical padding] or one padding for all screen sizes */
+    /** Represents vertical padding. Used to override the vertical padding from "space" prop.
+     * specify [small screen vertical padding, medium screen vertical padding, large screen vertical padding] or one padding for all screen sizes */
     vSpace?: SpaceSizes | MQ<SpaceSizes>;
+    /** Text alignment prop.
+     * specify [small screen alignText, medium screen alignText, large screen alignText] or one alignText for all screen sizes */
     alignText?: TextAlignment | MQ<TextAlignment>;
@@ -11,0 +17,0 @@ };

build/src/components/Column/Columns.d.ts

@@ -5,3 +5,3 @@ import React from "react";
     children: React.ReactNode[] | React.ReactNode;
-    /** represents the size of both horizontal and vertical gap between columns, can be a single string or an array of 3 strings
+    /** represents the size of both horizontal and vertical gap between children, can be a single string or an array of 3 strings
      * specify [small screen gap size, medium screen gap size, large screen gap size] to apply different gap sizes for different screen sizes
@@ -13,6 +13,10 @@ */
     alwaysFillSpace?: boolean;
-    /** specify horizontal alignment */
-    alignItems?: HorizontalAlignment;
-    /** specify vertical alignment */
-    vAlignItems?: VerticalAlignment;
+    /** specify horizontal alignment
+     * specify [small screen alignItems, medium screen alignItems, large screen alignItems] to apply different alignItems for different screen sizes
+     */
+    alignItems?: HorizontalAlignment | MQ<HorizontalAlignment>;
+    /** specify vertical alignment
+     * specify [small screen vAlignItems, medium screen vAlignItems, large screen vAlignItems] to apply different vAlignItems for different screen sizes
+     */
+    vAlignItems?: VerticalAlignment | MQ<VerticalAlignment>;
 }
@@ -19,0 +23,0 @@ export declare function Columns({ children, gap, alwaysFillSpace, alignItems, vAlignItems, }: ColumnsProps): React.ReactElement;

build/src/components/Inline/Inline.d.ts

 import React from "react";
-import { HorizontalAlignment, SpaceSizes, VerticalAlignment } from "../../types";
+import { HorizontalAlignment, SpaceSizes, VerticalAlignment, MQ } from "../../types";
 declare type InlineProps = {
     children: React.ReactNode[] | React.ReactElement;
-    /** specify vertical alignment */
-    alignItems?: HorizontalAlignment;
-    vAlignItems?: VerticalAlignment;
-    /** specify size */
-    space?: SpaceSizes;
+    /** Represents the spacing between the Inline's children
+     * specify [small screen space, medium screen space, large screen space] or one space for all screen sizes
+     */
+    space?: MQ<SpaceSizes> | SpaceSizes;
+    /** Represents elements' horizontal alignment
+     * specify [small screen alignItems, medium screen alignItems, large screen alignItems] or one alignItems for all screen sizes
+     */
+    alignItems?: MQ<HorizontalAlignment> | HorizontalAlignment;
+    /** Represents elements' vertical alignment
+     * specify [small screen vAlignItems, medium screen vAlignItems, large screen vAlignItems] or one vAlignItems for all screen sizes
+     */
+    vAlignItems?: MQ<VerticalAlignment> | VerticalAlignment;
+    /** Set to true to disable wrapping property */
     noWrap?: boolean;
@@ -11,0 +19,0 @@ };

build/src/components/Stack/Stack.d.ts

 import React from "react";
-import { SpaceSizes } from "../../types";
+import { MQ, SpaceSizes } from "../../types";
 declare type StackProps = {
+    /** Represents the vertical between the Stack's children
+     * specify [small screen space, medium screen space, large screen space] or one space for all screen sizes
+     */
+    space?: MQ<SpaceSizes> | SpaceSizes;
     children: React.ReactNode[] | React.ReactElement;
-    space?: SpaceSizes;
 };
@@ -7,0 +10,0 @@ export declare function Stack({ children, space }: StackProps): React.ReactElement;

CHANGELOG.md

@@ -1,9 +0,19 @@
-# v0.6.0 (Tue Apr 20 2021)
+# v0.7.0 (Tue Apr 20 2021)
 
+### Release Notes
+
+#### COR-1173 Add mq to <Stack /> and  <Inline />  and improve docs ([#163](https://github.com/amboss-mededu/amboss-design-system/pull/163))
+
+### PR-Server Link
+- [Design system](https://COR-1173-docs.design.de.qa.medicuja.de)
+
+---
+
 #### 🚀 Enhancement
 
-- introduce Toggle component for forms [#165](https://github.com/amboss-mededu/amboss-design-system/pull/165) ([@clbagrat](https://github.com/clbagrat))
+- COR-1173 Add mq to <Stack /> and  <Inline />  and improve docs [#163](https://github.com/amboss-mededu/amboss-design-system/pull/163) ([@clbagrat](https://github.com/clbagrat) [@OlfaKaroui](https://github.com/OlfaKaroui))
 
-#### Authors: 1
+#### Authors: 2
 
 - Gobedashvili Bagrat ([@clbagrat](https://github.com/clbagrat))
+- Olfa Karoui ([@OlfaKaroui](https://github.com/OlfaKaroui))

package.json

 {
   "name": "@amboss/design-system",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "the design system for AMBOSS products",
@@ -5,0 +5,0 @@ "author": "Bagrat Gobedashvili",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1091867

increased by7.47%

Lines of code

2346

increased by6.73%

Worsened metrics

Number of low supply chain risk alerts

58

increased by7.41%

No dependency changes