Skip to content

Commit

Permalink
docs: update stories, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
atanasster committed Mar 9, 2020
1 parent 6dc7ee2 commit 11cecc3
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
14 changes: 13 additions & 1 deletion ui/components/README.md
@@ -1 +1,13 @@
# Componnet Control Editors
# @component-controls/components

> Component controls user interface components
## Installation

This package is usually installed as part of the @component-controls package, but you can also install it standalone

```bash
$ npm install @component-controls/components --save-dev
```

# Components
6 changes: 6 additions & 0 deletions ui/components/src/Markdown/Markdown.tsx
Expand Up @@ -4,7 +4,13 @@ import MarkdownToJSX, { MarkdownOptions } from 'markdown-to-jsx';
import { SyntaxHighlighter } from '../SyntaxHighlighter';

export interface MarkdownProps {
/**
* the markdown code is passed as a children prop
*/
children: string;
/**
* components to customize the markdown display
*/
components?: MarkdownOptions['overrides'];
}

Expand Down
5 changes: 5 additions & 0 deletions ui/components/src/Popover/Popover.tsx
Expand Up @@ -80,6 +80,11 @@ export const Arrow = styled.div<{ placement: string; borderColor: string }>(
}),
);

/**
* A Popover container that is triggered by a click, or hover
* used to display enhanced information that could not fit into the main scren
*
*/
export const Popover: FC<PopoverProps> = ({
trigger,
placement = 'bottom',
Expand Down

0 comments on commit 11cecc3

Please sign in to comment.