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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CONTRIBUTING.md CHANGED
@@ -41,6 +41,18 @@ Before opening a Pull Request, please see the Submission Guidelines below.
41
41
  You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/lumapps/design-system/issues).
42
42
  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.
43
43
 
44
+ ## <a name="create-a-new-react-component-"></a> Want to create a new React Component?
45
+
46
+ The first step to create a new React component is to run:
47
+
48
+ ```
49
+ yarn scaffold
50
+ ```
51
+
52
+ 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.
53
+
54
+ To export your component into the `@lumx/react` NPM package, you also have to make sure to update the `src/index.tsx` file.
55
+
44
56
  ## <a name="submission-guidelines"></a> Submission guidelines
45
57
 
46
58
  ### Submitting an issue
@@ -13,7 +13,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
13
13
  */
14
14
  declare const Button: import('vue').DefineSetupFnComponent<ButtonProps, {
15
15
  click: (event: MouseEvent) => boolean;
16
- }, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
16
+ }, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
17
17
  class?: string;
18
18
  } & {
19
19
  onClick?: ((event: MouseEvent) => any) | undefined;
@@ -7,7 +7,7 @@ export type ButtonGroupProps = VueToJSXProps<UIProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const ButtonGroup: import('vue').DefineSetupFnComponent<ButtonGroupProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const ButtonGroup: import('vue').DefineSetupFnComponent<ButtonGroupProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default ButtonGroup;
@@ -12,7 +12,7 @@ export declare const emitSchema: {
12
12
  */
13
13
  declare const IconButton: import('vue').DefineSetupFnComponent<IconButtonProps, {
14
14
  click: (event: MouseEvent) => boolean;
15
- }, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
15
+ }, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
16
16
  class?: string;
17
17
  } & {
18
18
  onClick?: ((event: MouseEvent) => any) | undefined;
@@ -13,7 +13,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS, INTERMEDIATE_STATE };
13
13
  */
14
14
  declare const Checkbox: import('vue').DefineSetupFnComponent<CheckboxProps, {
15
15
  change: (isChecked: boolean, value?: string, name?: string, event?: Event) => boolean;
16
- }, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick" | "inputRef" | "inputId"> & {
16
+ }, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange" | "inputRef" | "inputId"> & {
17
17
  class?: string;
18
18
  } & {
19
19
  onChange?: ((isChecked: boolean, value?: string | undefined, name?: string | undefined, event?: Event | undefined) => any) | undefined;
@@ -8,7 +8,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
8
8
  * @param props Component props.
9
9
  * @return Vue element.
10
10
  */
11
- declare const Divider: import('vue').DefineSetupFnComponent<DividerProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
11
+ declare const Divider: import('vue').DefineSetupFnComponent<DividerProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
12
12
  class?: string;
13
13
  } & {}, import('vue').PublicProps>;
14
14
  export default Divider;
@@ -7,7 +7,7 @@ export type FlagProps = VueToJSXProps<UIProps, 'Text'>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const Flag: import('vue').DefineSetupFnComponent<FlagProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick" | "Text"> & {
10
+ declare const Flag: import('vue').DefineSetupFnComponent<FlagProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange" | "Text"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default Flag;
@@ -11,7 +11,7 @@ export { CLASSNAME, COMPONENT_NAME };
11
11
  * @param props Component props.
12
12
  * @return Vue element.
13
13
  */
14
- declare const FlexBox: import('vue').DefineSetupFnComponent<FlexBoxProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
14
+ declare const FlexBox: import('vue').DefineSetupFnComponent<FlexBoxProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
15
15
  class?: string;
16
16
  } & {
17
17
  /** Customize the root element. */
@@ -7,7 +7,7 @@ export type HeadingVueProps = VueToJSXProps<HeadingProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const Heading: import('vue').DefineSetupFnComponent<HeadingVueProps, {}, {}, Omit<HeadingProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const Heading: import('vue').DefineSetupFnComponent<HeadingVueProps, {}, {}, Omit<HeadingProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default Heading;
@@ -7,7 +7,7 @@ export type IconProps = VueToJSXProps<UIProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const Icon: import('vue').DefineSetupFnComponent<IconProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const Icon: import('vue').DefineSetupFnComponent<IconProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default Icon;
@@ -7,7 +7,7 @@ export type InputHelperProps = VueToJSXProps<UIProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const InputHelper: import('vue').DefineSetupFnComponent<InputHelperProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const InputHelper: import('vue').DefineSetupFnComponent<InputHelperProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default InputHelper;
@@ -7,7 +7,7 @@ export type InputLabelProps = VueToJSXProps<UIProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const InputLabel: import('vue').DefineSetupFnComponent<InputLabelProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const InputLabel: import('vue').DefineSetupFnComponent<InputLabelProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default InputLabel;
@@ -0,0 +1,21 @@
1
+ import { LinkProps as UIProps, CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS } from '@lumx/core/js/components/Link';
2
+ import { VueToJSXProps } from '../../utils/VueToJSX';
3
+ export type LinkProps = VueToJSXProps<UIProps, 'label'>;
4
+ export declare const emitSchema: {
5
+ click: (event: Event) => boolean;
6
+ };
7
+ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
8
+ /**
9
+ * Link component.
10
+ *
11
+ * @param props Component props.
12
+ * @return Vue element.
13
+ */
14
+ declare const Link: import('vue').DefineSetupFnComponent<LinkProps, {
15
+ click: (event: Event) => boolean;
16
+ }, {}, Omit<UIProps, "className" | "label" | "children" | "onClick" | "ref" | "onChange"> & {
17
+ class?: string;
18
+ } & {
19
+ onClick?: ((event: Event) => any) | undefined;
20
+ }, import('vue').PublicProps>;
21
+ export default Link;
@@ -0,0 +1,2 @@
1
+ export { default as Link } from './Link';
2
+ export type { LinkProps } from './Link';
@@ -14,7 +14,7 @@ export interface MessageEmits {
14
14
  * @param props Component props.
15
15
  * @return Vue element.
16
16
  */
17
- declare const Message: import('vue').DefineSetupFnComponent<MessageProps, "close"[], {}, Omit<Omit<UIProps, "closeButtonProps">, "className" | "children" | "ref" | "onChange" | "onClick"> & {
17
+ declare const Message: import('vue').DefineSetupFnComponent<MessageProps, "close"[], {}, Omit<Omit<UIProps, "closeButtonProps">, "className" | "children" | "onClick" | "ref" | "onChange"> & {
18
18
  class?: string;
19
19
  } & {
20
20
  /** label to be used for the close button */
@@ -13,7 +13,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
13
13
  */
14
14
  declare const RadioButton: import('vue').DefineSetupFnComponent<RadioButtonProps, {
15
15
  change: (value?: string, name?: string, event?: Event) => event is Event;
16
- }, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick" | "inputRef" | "inputId"> & {
16
+ }, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange" | "inputRef" | "inputId"> & {
17
17
  class?: string;
18
18
  } & {
19
19
  onChange?: ((value?: string | undefined, name?: string | undefined, event?: Event | undefined) => any) | undefined;
@@ -8,7 +8,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
8
8
  * @param props Component props.
9
9
  * @return Vue element.
10
10
  */
11
- declare const SkeletonCircle: import('vue').DefineSetupFnComponent<SkeletonCircleProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
11
+ declare const SkeletonCircle: import('vue').DefineSetupFnComponent<SkeletonCircleProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
12
12
  class?: string;
13
13
  } & {}, import('vue').PublicProps>;
14
14
  export default SkeletonCircle;
@@ -8,7 +8,7 @@ export { SkeletonRectangleVariant, CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
8
8
  * @param props Component props.
9
9
  * @return Vue element.
10
10
  */
11
- declare const SkeletonRectangle: import('vue').DefineSetupFnComponent<SkeletonRectangleProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
11
+ declare const SkeletonRectangle: import('vue').DefineSetupFnComponent<SkeletonRectangleProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
12
12
  class?: string;
13
13
  } & {}, import('vue').PublicProps>;
14
14
  export default SkeletonRectangle;
@@ -8,7 +8,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
8
8
  * @param props Component props.
9
9
  * @return Vue element.
10
10
  */
11
- declare const SkeletonTypography: import('vue').DefineSetupFnComponent<SkeletonTypographyProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
11
+ declare const SkeletonTypography: import('vue').DefineSetupFnComponent<SkeletonTypographyProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
12
12
  class?: string;
13
13
  } & {}, import('vue').PublicProps>;
14
14
  export default SkeletonTypography;
@@ -1,10 +1,7 @@
1
- import { default as SkeletonCircle, SkeletonCircleProps } from './SkeletonCircle';
2
- import { default as SkeletonRectangle, SkeletonRectangleProps, SkeletonRectangleVariant } from './SkeletonRectangle';
3
- import { default as SkeletonTypography, SkeletonTypographyProps } from './SkeletonTypography';
4
- export { SkeletonCircle };
5
- export type { SkeletonCircleProps };
6
- export { SkeletonRectangle };
7
- export type { SkeletonRectangleProps };
8
- export { SkeletonRectangleVariant };
9
- export { SkeletonTypography };
10
- export type { SkeletonTypographyProps };
1
+ export { default as SkeletonCircle } from './SkeletonCircle';
2
+ export type { SkeletonCircleProps } from './SkeletonCircle';
3
+ export { default as SkeletonRectangle } from './SkeletonRectangle';
4
+ export type { SkeletonRectangleProps } from './SkeletonRectangle';
5
+ export { SkeletonRectangleVariant } from './SkeletonRectangle';
6
+ export { default as SkeletonTypography } from './SkeletonTypography';
7
+ export type { SkeletonTypographyProps } from './SkeletonTypography';
@@ -13,7 +13,7 @@ export { CLASSNAME, COMPONENT_NAME, DEFAULT_PROPS };
13
13
  */
14
14
  declare const Switch: import('vue').DefineSetupFnComponent<SwitchProps, {
15
15
  change: (isChecked: boolean, value?: string, name?: string, event?: Event) => boolean;
16
- }, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick" | "inputRef" | "inputId"> & {
16
+ }, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange" | "inputRef" | "inputId"> & {
17
17
  class?: string;
18
18
  } & {
19
19
  onChange?: ((isChecked: boolean, value?: string | undefined, name?: string | undefined, event?: Event | undefined) => any) | undefined;
@@ -7,7 +7,7 @@ export type TextProps = VueToJSXProps<UIProps>;
7
7
  * @param props Component props.
8
8
  * @return Vue element.
9
9
  */
10
- declare const Text: import('vue').DefineSetupFnComponent<TextProps, {}, {}, Omit<UIProps, "className" | "children" | "ref" | "onChange" | "onClick"> & {
10
+ declare const Text: import('vue').DefineSetupFnComponent<TextProps, {}, {}, Omit<UIProps, "className" | "children" | "onClick" | "ref" | "onChange"> & {
11
11
  class?: string;
12
12
  } & {}, import('vue').PublicProps>;
13
13
  export default Text;
package/index.d.ts CHANGED
@@ -1,6 +1,5 @@
1
1
  export * from '@lumx/core/js/constants';
2
2
  export * from '@lumx/core/js/types';
3
- export * from './components/badge';
4
3
  export * from './components/button';
5
4
  export * from './components/checkbox';
6
5
  export * from './components/divider';
@@ -10,6 +9,7 @@ export * from './components/heading';
10
9
  export * from './components/icon';
11
10
  export * from './components/input-helper';
12
11
  export * from './components/input-label';
12
+ export * from './components/link';
13
13
  export * from './components/message';
14
14
  export * from './components/radio-button';
15
15
  export * from './components/skeleton';