Rindo
A compiler for generating
Web Components
using technologies like TypeScript and JSX, built by the Family team.
### Getting Started
Start a new project by following our quick [Getting Started guide](https://rindojs.web.app/docs/getting-started).
We would love to hear from you!
If you have any feedback or run into issues using Rindo, please file an [issue](https://github.com/rindojs/rindo/issues/new) on this repository.
### Examples
A Rindo component looks a lot like a class-based React component, with the addition of TypeScript decorators:
```tsx
import { Component, Prop, h } from '@rindo/core';
@Component({
tag: 'my-component', // the name of the component's custom HTML tag
styleUrl: 'my-component.css', // css styles to apply to the component
shadow: true, // this component uses the ShadowDOM
})
export class MyComponent {
// The component accepts two arguments:
@Prop() first: string;
@Prop() last: string;
//The following HTML is rendered when our component is used
render() {
return (
Hello, my name is {this.first} {this.last}
);
}
}
```
The component above can be used like any other HTML element:
```html
```
Since Rindo generates web components, they work in any major framework or with no framework at all.
In many cases, Rindo can be used as a drop in replacement for traditional frontend framework, though using it as such is certainly not required.
### Contributing
Thanks for your interest in contributing!
Please take a moment to read up on our guidelines for [contributing](https://github.com/rindojs/rindo/blob/main/CONTRIBUTING.md).
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/rindojs/rindo/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.