@lumx/react 4.3.2-alpha.1 → 4.3.2-alpha.2

package/CONTRIBUTING.md

@@ -41,6 +41,18 @@ Before opening a Pull Request, please see the Submission Guidelines below.
 You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/lumapps/design-system/issues).
 If you would like to implement a new feature then consider what kind of change it is, discuss it with us before hand in your issue, so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
 
+## <a name="create-a-new-react-component-"></a> Want to create a new React Component?
+
+The first step to create a new React component is to run:
+
+```
+yarn scaffold
+```
+
+This script will generate a TSX file for the component code, a TSX file for the component tests and an MDX file to demo this component.
+
+To export your component into the `@lumx/react` NPM package, you also have to make sure to update the `src/index.tsx` file.
+
 ## <a name="submission-guidelines"></a> Submission guidelines
 
 ### Submitting an issue

package/index.d.ts

@@ -294,6 +294,32 @@ interface AvatarProps extends GenericProps, HasTheme$1 {
  */
 declare const Avatar: Comp<AvatarProps, HTMLDivElement>;
 
+/**
+ * Defines the props of the component.
+ */
+interface BadgeProps extends GenericProps {
+    /** Badge content. */
+    children?: ReactNode;
+    /** Color variant. */
+    color?: ColorPalette$1;
+}
+/**
+ * Badge component.
+ *
+ * @param  props Component props.
+ * @param  ref   Component ref.
+ * @return React element.
+ */
+declare const Badge: Comp<BadgeProps, HTMLDivElement>;
+
+interface BadgeWrapperProps extends GenericProps {
+    /** Badge. */
+    badge: ReactElement;
+    /** Node to display the badge on */
+    children: ReactNode;
+}
+declare const BadgeWrapper: Comp<BadgeWrapperProps, HTMLDivElement>;
+
 /**
  * Alignments.
  */
@@ -541,51 +567,6 @@ interface HasDisabled {
     disabled?: boolean;
 }
 
-/**
- * Defines the props of the component.
- */
-interface BadgeProps$1 extends HasClassName {
-    /** Badge content. */
-    children?: JSXElement;
-    /** Color variant. */
-    color?: ColorPalette;
-    /** reference to the root element */
-    ref?: CommonRef;
-}
-
-/**
- * Defines the props of the component.
- */
-interface BadgeProps extends Omit<BadgeProps$1, 'children'>, GenericProps {
-    /** Badge content. */
-    children?: ReactNode;
-}
-/**
- * Badge component.
- *
- * @param  props Component props.
- * @param  ref   Component ref.
- * @return React element.
- */
-declare const Badge: Comp<BadgeProps, HTMLDivElement>;
-
-interface BadgeWrapperProps$1 extends HasClassName {
-    /** Badge element to display */
-    badge?: JSXElement;
-    /** Content to wrap with badge */
-    children?: JSXElement;
-    /** Ref forwarding */
-    ref?: CommonRef;
-}
-
-interface BadgeWrapperProps extends GenericProps, Omit<BadgeWrapperProps$1, 'children' | 'badge'> {
-    /** Badge element to display */
-    badge: ReactElement;
-    /** Content to wrap with badge */
-    children: ReactNode;
-}
-declare const BadgeWrapper: Comp<BadgeWrapperProps, HTMLDivElement>;
-
 interface BaseClickableProps extends HasDisabled, HasAriaDisabled {
     children?: JSXElement;
     onClick?: (event?: any) => void;
@@ -2059,37 +2040,55 @@ interface LightboxProps extends GenericProps, HasTheme$1, Pick<AriaAttributes, '
  */
 declare const Lightbox: Comp<LightboxProps, HTMLDivElement>;
 
-type HTMLAnchorProps = React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>;
 /**
  * Defines the props of the component.
  */
-interface LinkProps extends GenericProps, HasAriaDisabled$1 {
+interface LinkProps$1 extends HasTheme, HasClassName, HasAriaDisabled, HasDisabled {
+    /** Link label content. */
+    label?: JSXElement;
     /** Color variant. */
     color?: ColorWithVariants$1;
     /** Lightened or darkened variant of the selected icon color. */
     colorVariant?: ColorVariant$1;
     /** Link href. */
-    href?: HTMLAnchorProps['href'];
-    /** Whether the component is disabled or not. */
-    isDisabled?: boolean;
+    href?: string;
     /**
      * Left icon (SVG path).
-     * @deprecated Instead, simply nest `<Icon />` in the children
+     * @deprecated Instead, simply nest `<Icon />` in the label
      */
     leftIcon?: string;
-    /** Custom react component for the link (can be used to inject react router Link). */
-    linkAs?: 'a' | any;
+    /** Element type or custom component for the link. */
+    as?: string | any;
     /**
      * Right icon (SVG path).
-     * @deprecated Instead, simply nest `<Icon />` in the children
+     * @deprecated Instead, simply nest `<Icon />` in the label
      */
     rightIcon?: string;
     /** Link target. */
+    target?: string;
+    /** Typography variant. */
+    typography?: string;
+    /** Click handler. */
+    onClick?: (event: any) => void;
+    /** Reference to the root element. */
+    ref?: CommonRef;
+}
+
+type HTMLAnchorProps = React__default.DetailedHTMLProps<React__default.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>;
+/**
+ * Defines the props of the component.
+ */
+interface LinkProps extends GenericProps, Omit<LinkProps$1, 'label'> {
+    /** Link href. */
+    href?: HTMLAnchorProps['href'];
+    /** Custom react component for the link (can be used to inject react router Link). */
+    linkAs?: 'a' | any;
+    /** Link target. */
     target?: HTMLAnchorProps['target'];
     /** Typography variant. */
     typography?: Typography$1;
     /** Children */
-    children?: React.ReactNode;
+    children?: React__default.ReactNode;
 }
 /**
  * Link component.