@ebrains/react 0.0.1-alpha.0
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/README.md +51 -0
- package/index.esm.d.ts +1 -0
- package/index.esm.js +2669 -0
- package/package.json +8 -0
- package/src/generated/components.d.ts +38 -0
- package/src/generated/react-component-lib/attachProps.d.ts +16 -0
- package/src/generated/react-component-lib/case.d.ts +2 -0
- package/src/generated/react-component-lib/createComponent.d.ts +10 -0
- package/src/generated/react-component-lib/createOverlayComponent.d.ts +21 -0
- package/src/generated/react-component-lib/dev.d.ts +2 -0
- package/src/generated/react-component-lib/index.d.ts +2 -0
- package/src/generated/react-component-lib/interfaces.d.ts +29 -0
- package/src/generated/react-component-lib/utils/attachProps.d.ts +16 -0
- package/src/generated/react-component-lib/utils/case.d.ts +2 -0
- package/src/generated/react-component-lib/utils/dev.d.ts +2 -0
- package/src/generated/react-component-lib/utils/index.d.ts +10 -0
- package/src/index.d.ts +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Overview
|
|
2
|
+
|
|
3
|
+
The `ebrains-ui-ecosystem` is a platform for managing the design system, UI components, and applications across EBRAINS products.
|
|
4
|
+
|
|
5
|
+
## Tech Stack
|
|
6
|
+
|
|
7
|
+
- **Trunk-based-development**: This repository follows the trunk bases development [worklflow](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development)
|
|
8
|
+
- **Feature Flags**: It also make use of feature flags ([GitLab](https://gitlab.ebrains.eu/ri/tech-hub/design-system/ebrains-ui-ecosystem/-/feature_flags), [FF](https://www.atlassian.com/solutions/devops/integrations/feature-flags))
|
|
9
|
+
|
|
10
|
+
- **Nx Monorepo**: Facilitates efficient management of multiple apps and libraries within a single repository, enabling code sharing and collaboration.
|
|
11
|
+
- **Stencil.js**: A powerful tool for building reusable, framework-agnostic web components. Supports multiple **output targets**, including **Vanilla JS**, **Vue**, and **React**, ensuring compatibility across various front-end frameworks.
|
|
12
|
+
- **Tailwind CSS**: A utility-first CSS framework to enforce design consistency and create highly customizable, responsive UI components.
|
|
13
|
+
|
|
14
|
+
## Output
|
|
15
|
+
|
|
16
|
+
### Documentation
|
|
17
|
+
|
|
18
|
+
The `ebrains-ui-ecosystem` will leverage Stencil's built-in docs generation feature and Hugo's features to produce high-level documentation. This will include detailed information about different aspects of the design system, such as **foundations** (typography, colors, spacing), **components**, and **patterns**. The documentation will be hosted under a dedicated domain, ensuring easy access and consistency across teams.
|
|
19
|
+
|
|
20
|
+
### Storybook
|
|
21
|
+
|
|
22
|
+
The `ebrains-ui-ecosystem` will deliver component stories for interactive demoing and practice before development under a dedicated domain.
|
|
23
|
+
|
|
24
|
+
### NPM Packages/CDN
|
|
25
|
+
|
|
26
|
+
The ecosystem will produce several npm-publishable packages under the **`@ebrains`** namespace:
|
|
27
|
+
|
|
28
|
+
- **@ebrains/components**: Core reusable UI components.
|
|
29
|
+
- **@ebrains/react**: React-specific component library.
|
|
30
|
+
- **@ebrains/vue**: Vue-specific component library.
|
|
31
|
+
- **@ebrains/angular**: Angular-specific component library.
|
|
32
|
+
- **@ebrains/assets**: Shared styles and Tailwind configurations.
|
|
33
|
+
- **@ebrains/fonts**: Font resources.
|
|
34
|
+
- **@ebrains/svgs**: SVG icons and assets.
|
|
35
|
+
|
|
36
|
+
## Flexibility
|
|
37
|
+
|
|
38
|
+
Developers can leverage the `ebrains-ui-ecosystem` by either:
|
|
39
|
+
|
|
40
|
+
- Using **npm packages** like `@ebrains/components`, `@ebrains/styles`, etc.
|
|
41
|
+
- Including **normal HTML tags** to directly load scripts and styles without strong dependencies.
|
|
42
|
+
|
|
43
|
+
Additionally, if consumer applications integrate their efforts under the ecosystem, they will automatically inherit all packages, eliminating the need for separate installations or managing versions.
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
## How to Run it
|
|
47
|
+
|
|
48
|
+
- Clone the repository
|
|
49
|
+
- Install NX: `npm install -g nx`
|
|
50
|
+
- Install Project Dependencies: `npm install`
|
|
51
|
+
- Run the documentation: `nx serve eds-docs`
|
package/index.esm.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./src/index";
|