Skip to content

Commit

Permalink
update readme to include install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdholt committed May 12, 2020
1 parent 6169d67 commit aaa91e7
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 26 deletions.
8 changes: 5 additions & 3 deletions packages/web-components/fast-components-msft/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# FAST Components MSFT

## Development
A set of React components which implements the Microsoft styling.

To start the component development environment, run `yarn start`.
## Installation

### Known issue with Storybook site hot-reloading
`npm i --save @microsoft/fast-components-msft`

### Known issue with Storybook site hot-reloading during development

Storybook will watch modules for changes and hot-reload the module when necessary. This is usually great but poses a problem when the module being hot-reloaded defines a custom element. A custom element name can only be defined by the `CustomElementsRegistry` once, so reloading a module that defines a custom element will attempt to re-register the custom element name, throwing an error because the name has already been defined. This error will manifest with the following message:
`Failed to execute 'define' on 'CustomElementRegistry': the name "my-custom-element-name" has already been used with this registry`
Expand Down
36 changes: 18 additions & 18 deletions packages/web-components/fast-components-msft/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
export * from "./anchor.js";
export * from "./badge.js";
export * from "./button.js";
export * from "./card.js";
export * from "./checkbox.js";
export * from "./design-system-provider.js";
export * from "./dialog.js";
export * from "./divider.js";
export * from "./flipper.js";
export * from "./progress.js";
export * from "./radio.js";
export * from "./radio-group.js";
export * from "./slider.js";
export * from "./slider-label.js";
export * from "./switch.js";
export * from "./tabs.js";
export * from "./text-area.js";
export * from "./text-field.js";
export * from "./anchor/index.js";
export * from "./badge/index.js";
export * from "./button/index.js";
export * from "./card/index.js";
export * from "./checkbox/index.js";
export * from "./design-system-provider/index.js";
export * from "./dialog/index.js";
export * from "./divider/index.js";
export * from "./flipper/index.js";
export * from "./progress/index.js";
export * from "./radio/index.js";
export * from "./radio-group/index.js";
export * from "./slider/index.js";
export * from "./slider-label/index.js";
export * from "./switch/index.js";
export * from "./tabs/index.js";
export * from "./text-area/index.js";
export * from "./text-field/index.js";
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export * from "./progress.js";
export * from "./progress-ring.js";
export * from "./progress/index.js";
export * from "./progress-ring/index.js";
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from "./patterns.js";
export * from "./patterns/index.js";
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ import { TabsStyles as styles } from "./tabs.styles.js";
styles,
})
export class MSFTTabs extends Tabs {}
export * from "./tab";
export * from "./tab-panel";
export * from "./tab/index.js";
export * from "./tab-panel/index.js";

0 comments on commit aaa91e7

Please sign in to comment.