@tecsinapse/cortex-react 1.2.0 → 1.2.1

package/README.md

@@ -1,11 +1,71 @@
-# `cortex-react`
+# TecSinapse Design System
 
-> TODO: description
+[![build workflow](https://github.com/tecsinapse/design-system/actions/workflows/publish.yml/badge.svg)](https://github.com/tecsinapse/design-system/actions/workflows/publish.yml)
 
-## Usage
+Welcome to [TecSinapse](https://www.tecsinapse.com.br/) Design System. This repo contains core components to build web and mobile applications.
+Our primary goal is to create a system that can be used to build a wide variety of TecSinapse websites and apps,
+while providing a consistent and inclusive user experience to our end users.
+In addition, the design system and component library should be easy to use for developers and designers.
 
+## Quick start
+
+Please refer to the official [documentation](https://tecsinapse.github.io/design-system).
+
+## Packages
+
+| Package                                                         | Content                                                                          | Version                                                                                                                                    |
+| --------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| **[@tecsinapse/react-core](./packages/react-core)**             | core primitives for `CSS-in-JS` packages                                         | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Freact-core.svg)](https://badge.fury.io/js/%40tecsinapse%2Freact-core)             |
+| **[@tecsinapse/react-web-kit](./packages/react-web-kit)**       | emotion `styled-components` for browsers with `react-native-web`                 | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Freact-web-kit.svg)](https://badge.fury.io/js/%40tecsinapse%2Freact-web-kit)       |
+| **[@tecsinapse/react-native-kit](./packages/react-native-kit)** | emotion native `styled-components` for `react-native` cross platform development | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Freact-native-kit.svg)](https://badge.fury.io/js/%40tecsinapse%2Freact-native-kit) |
+| **[@tecsinapse/react-charts](./packages/react-charts)**         | charts for react & react-native based on SVG                                     | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Freact-charts.svg)](https://badge.fury.io/js/%40tecsinapse%2Freact-charts)         |
+| **[@tecsinapse/cortex-core](./packages/cortex-core)**           | core primitives for `tailwindcss` packages                                       | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Fcortex-core.svg)](https://badge.fury.io/js/%40tecsinapse%2Fcortex-core)           |
+| **[@tecsinapse/cortex-react](./packages/cortex-react)**         | `html` based components using `cortex-core` primitives                           | [![npm version](https://badge.fury.io/js/%40tecsinapse%2Fcortex-react.svg)](https://badge.fury.io/js/%40tecsinapse%2Fcortex-react)         |
+
+## Code of conduct
+
+We want to foster an inclusive and friendly community around our Open Source efforts. This project follows the Contributor Covenant Code of Conduct.
+Please, [read it and follow it](./CODE_OF_CONDUCT.md).
+
+If you feel another member of the community violated our code or you are experiencing problems participating in our community because of another individual's behavior,
+please get in touch with our maintainers.
+
+## Running locally
+
+Recommended requirements:
+
+- `pnpm` >= 9
+- `node` >= 20
+
+To run locally, you should install the dependencies first:
+
+```
+pnpm i
 ```
-const index = require('cortex-react');
 
-// TODO: DEMONSTRATE API
+After this script, all packages will build. When developing, for a better experience, also use:
+
 ```
+pnpm dev
+```
+
+This script watch for changes on any package and rebuild files to reflect on live mode. To run storybook with all components, use:
+
+```
+pnpm storybook
+```
+
+For web development this is sufficient. For mobile, follow additional steps on [rn-playground](./packages/rn-playground).
+
+## How to make local changes available for other projects?
+
+Check [these docs](https://pnpm.io/cli/link).
+
+## Contributing
+
+If you have ideas for how we could improve this readme or the project in general, [let us know](https://github.com/tecsinapse/design-system/issues)!
+
+## About TecSinapse
+
+[TecSinapse](https://www.tecsinapse.com.br/) is a specialist in the automotive industry for over 15 years.
+We operate with diverse integrated solutions, from client prospecting to after-sales, plus market indicators tools and process improvement for complete management.\_

package/dist/types/components/Button.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { ButtonVariants } from '@tecsinapse/cortex-core';
 interface ButtonProps {
     variants?: ButtonVariants;
-    children?: JSX.Element;
+    children?: React.ReactNode;
 }
 export declare const Button: React.ForwardRefExoticComponent<ButtonProps & Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, "className"> & React.RefAttributes<HTMLButtonElement>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tecsinapse/cortex-react",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "React components based in @tecsinapse/cortex-core",
   "license": "MIT",
   "main": "dist/esm/index.js",
@@ -16,7 +16,7 @@
     "build:dts": "tsc --project tsconfig.build.json"
   },
   "dependencies": {
-    "@tecsinapse/cortex-core": "0.2.0",
+    "@tecsinapse/cortex-core": "0.2.1",
     "clsx": "*",
     "react-icons": "^5.2.1"
   },
@@ -34,5 +34,5 @@
     "react-dom": ">=18.0.0",
     "tailwind": ">=3.3.0"
   },
-  "gitHead": "5fdf13313937b667682216c4f86b6b84fa4612a4"
+  "gitHead": "dc62ed9d05cd238fc3f65dee50c5fef4a3d615e0"
 }

package/dist/types/docs/badge-anchor.stories.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        value: number;
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        value: {
-            control: {
-                type: string;
-            };
-            min: number;
-            max: number;
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/badge.stories.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        value: string;
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        value: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/button.stories.d.ts

@@ -1,30 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        variant: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        size: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/card.stories.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/hint.stories.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        intent: string;
-        description: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        description: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/input-custom.stories.d.ts

@@ -1,33 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        label: string;
-        placeholder: string;
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        label: {
-            control: {
-                type: string;
-            };
-        };
-        placeholder: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/input.stories.d.ts

@@ -1,33 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        label: string;
-        placeholder: string;
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        label: {
-            control: {
-                type: string;
-            };
-        };
-        placeholder: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/modal.stories.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/select-grouped.stories.d.ts

@@ -1,32 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    argTypes: {
-        variant: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        label: {
-            control: {
-                type: string;
-            };
-        };
-        placeholderSearchInput: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {
-        variant: string;
-        label: string;
-        placeholderSearchInput: string;
-    };
-};

package/dist/types/docs/select.stories.d.ts

@@ -1,32 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    argTypes: {
-        variant: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        label: {
-            control: {
-                type: string;
-            };
-        };
-        placeholderSearchInput: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {
-        variant: string;
-        label: string;
-        placeholderSearchInput: string;
-    };
-};

package/dist/types/docs/snackbar.stories.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/table.stories.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/tag.stories.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        intent: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/text-area.stories.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-    args: {
-        rows: number;
-        intent: string;
-        label: string;
-        placeholder: string;
-    };
-    argTypes: {
-        intent: {
-            options: string[];
-            control: {
-                type: string;
-            };
-        };
-        rows: {
-            control: {
-                type: string;
-            };
-        };
-        label: {
-            control: {
-                type: string;
-            };
-        };
-        placeholder: {
-            control: {
-                type: string;
-            };
-        };
-    };
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/toggle.stories.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-declare const _default: {
-    title: string;
-    component: JSX.Element;
-};
-export default _default;
-export declare const Base: {
-    render: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/types").Args>;
-    args: {};
-};

package/dist/types/docs/utils.d.ts

@@ -1 +0,0 @@
-export declare const defaultIntents: string[];