Skip to content

Infineon/infineon-design-system-stencil

Repository files navigation

Infineon Design System

GitHub Issues GitHub Pull Requests GitHub Version GitHub Commits GitHub Contributors Built With Stencil

A comprehensive design system built with Stencil providing web components and framework-specific wrappers for React, Angular, and Vue.

πŸš€ Quick Start

For more detailed instructions, see the Installation & Usage Guide.

Installation

# Using npm
npm install @infineon/infineon-design-system-stencil

# Using yarn
yarn add @infineon/infineon-design-system-stencil

# Using pnpm
pnpm add @infineon/infineon-design-system-stencil

Usage

Vanilla JavaScript / HTML

<script type="module" src="https://cdn.jsdelivr.net/npm/@infineon/infineon-design-system-stencil"></script>

<ifx-button>Click Me</ifx-button>

React

npm install @infineon/infineon-design-system-react
import { IfxButton } from '@infineon/infineon-design-system-react';

function App() {
  return <IfxButton>Click Me</IfxButton>;
}

Angular

npm install @infineon/infineon-design-system-angular
import { IfxComponentsModule } from '@infineon/infineon-design-system-angular';

@NgModule({
  imports: [IfxComponentsModule]
})
export class AppModule {}

Vue

npm install @infineon/infineon-design-system-vue
import { ComponentLibrary } from '@infineon/infineon-design-system-vue';

app.use(ComponentLibrary);

πŸ“¦ Packages

This monorepo contains the following packages:

Package Description Version
@infineon/infineon-design-system-stencil Core Stencil component library npm
@infineon/infineon-design-system-react React wrapper npm
@infineon/infineon-design-system-angular Angular wrapper npm
@infineon/infineon-design-system-vue Vue wrapper npm

πŸ—οΈ Repository Structure

infineon-design-system-stencil/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ components/           # Core Stencil component library
β”‚   β”œβ”€β”€ wrapper-react/        # React wrapper
β”‚   β”œβ”€β”€ wrapper-angular/      # Angular wrapper
β”‚   └── wrapper-vue/          # Vue wrapper
β”œβ”€β”€ examples/
β”‚   β”œβ”€β”€ html-cdn-example/     # HTML with CDN
β”‚   β”œβ”€β”€ html-vite-example/    # HTML with Vite bundler
β”‚   β”œβ”€β”€ react-example/        # React integration example
β”‚   β”œβ”€β”€ angular-standalone-example/  # Angular standalone example
β”‚   β”œβ”€β”€ angular-module-example/      # Angular module example
β”‚   └── vue-example/          # Vue integration example
└── example-generator/        # Tool for generating examples from stories

πŸ’» Development

For detailed development instructions, see CONTRIBUTING.md.

Prerequisites

  • Node.js: >= 18.0.0
  • pnpm: >= 8.0.0

Setup

# Install dependencies
pnpm install

# Build the core components
pnpm run build:components

πŸ“š Documentation

Quick Links

Additional Resources

🎨 Storybook

View Live Storybook β†’

Or run locally:

cd packages/components
pnpm run storybook

The Storybook will be available at http://localhost:6262

πŸ§ͺ Example Applications

All example applications demonstrate real-world usage of the design system:

Example App Live Demo Dev Port Command
HTML CDN Example View β†’ 3001 pnpm -F html-cdn-example dev
HTML Vite Example View β†’ 3002 pnpm -F html-vite-example dev
Angular Standalone Example View β†’ 3003 pnpm -F angular-standalone-example dev
Angular Module Example View β†’ 3004 pnpm -F angular-module-example dev
React Example View β†’ 3005 pnpm -F react-example dev
Vue Example View β†’ 3006 pnpm -F vue-example dev

Each example supports:

  • dev - Start development server
  • build - Build for production
  • preview - Preview production build

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details on:

  • Setting up your development environment
  • Code standards and best practices
  • Submitting pull requests
  • Running tests and linting

πŸ“„ License

See LICENSE file for details.

πŸ”’ Security

For security concerns, please see our Security Policy.

πŸ”— Links

πŸ“ž Contact

Email: dds@infineon.com

Packages

 
 
 

Contributors