https://github.com/dolittle/interaction.web
https://github.com/dolittle/interaction.web
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dolittle/interaction.web
- Owner: dolittle
- License: mit
- Created: 2020-07-07T05:45:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T14:24:51.000Z (over 4 years ago)
- Last Synced: 2025-02-01T21:38:08.559Z (4 months ago)
- Language: TypeScript
- Size: 113 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fluent UI for Aurelia
[](https://dolittle.visualstudio.com/Dolittle%20open-source%20repositories/_build/latest?definitionId=72&branchName=master)
This project is a wrapper of the official [React components for Fluent UI from Microsoft](https://developer.microsoft.com/en-us/fabric#/controls/web)
bringing it to [Aurelia](https://aurelia.io).
## Using
Add a dependency to this package:
```shell
$ npm i @dolittle/fluentui.aurelia
```
...or
```shell
$ yarn add @dolittle/fluentui.aurelia
```
In your Aurelia setup (`main.js`):
```javascript
aurelia.use.plugin(PLATFORM.moduleName('@dolittle/fluentui.aurelia');
```
## Getting started
This project is using [Yarn workspaces](https://github.com/dolittle-tools/JavaScript.Build).
To get started you can simply run:
```shell
$ yarn
```
At the root of the project.
## Building
Both for publishing and for working locally one needs to build on change. This can be done by doing:
```shell
$ yarn build
```
For VSCode users there is a default [tasks.json](./vscode/tasks.json) file with a default build task.
This means you can use the default keystroke for building (CMD+SHIFT+B on Mac, CTRL+SHIFT+B on Windows/Linux).
## Components Gallery
The purpose of the components gallery is to enable a simple place to go to for reference on how to use a component.
When working locally, it depends on the use of Yarn workspaces.
For running the control gallery, just do the following from the folder called `Gallery`:
First run the following:
```shell
$ yarn
```
Then run:
```shell
$ yarn start
```
This will start the Webpack DevServer and it will react to any changes, also those happening from the build.
It depends on the package in `Source` having been built first.
## Issues and Contributing
To learn how to contribute please read our [contributing](https://dolittle.io/contributing/) guide.
File issues to our [Home](https://github.com/dolittle/Home/issues) repository.