chnages to sidenav

This commit is contained in:
Adan Ulloa 2020-01-20 12:00:19 -06:00
commit a77127000d
186 changed files with 10791 additions and 833 deletions

153
README.md
View file

@ -1,131 +1,39 @@
# carbon-components-svelte
> 🚧 UNDER CONSTRUCTION
[![NPM][npm]][npm-url]
[![Build][build]][build-badge]
> Svelte implementation of the Carbon Design System
> Svelte implementation of the [Carbon Design System](https://github.com/carbon-design-system)
Currently, this project is under active development. See the [ongoing project](https://github.com/IBM/carbon-components-svelte/projects/1) for the anticipated v1.0.0 release.
**NOTE**: Currently, this project is under active development. See the [issue tracker](https://github.com/IBM/carbon-components-svelte/projects/1) for the anticipated v1.0.0 release.
## [Storybook](https://ibm.github.io/carbon-components-svelte)
## [Storybook](https://ibm.github.io/carbon-components-svelte) · [CodeSandbox](https://codesandbox.io/s/carbon-components-svelte021-lhvc4)
## Supported Components
## Getting Started
Currently, the following components are supported:
`carbon-components-svelte` can be installed as a development dependency.
- Accordion
- AccordionItem
- AccordionSkeleton
- Breadcrumb
- BreadcrumbItem
- BreadcrumbSkeleton
- Button
- ButtonSkeleton
- Checkbox
- CheckboxSkeleton
- CodeSnippet
- CodeSnippetSkeleton
- ComposedModal
- ModalHeader
- ModalBody
- ModalFooter
- ContentSwitcher
- Switch
- Copy
- CopyButton
- DataTableSkeleton
- DatePicker
- DatePickerInput
- FileUploader
- FileUploaderButton
- FileUploaderItem
- FileUploaderDropContainer
- Filename
- Form
- FormGroup
- FormItem
- FormLabel
- Icon
- IconSkeleton
- InlineLoading
- Link
- ListBox
- ListBoxField
- ListBoxMenu
- ListBoxMenuIcon
- ListBoxMenuItem
- ListBoxSelection
- ListItem
- Loading
- Modal
- Notification
- ToastNotification
- InlineNotification
- NotificationActionButton
- NotificationButton
- NotificationIcon
- NotificationTextDetails
- NumberInput
- NumberInputSkeleton
- OrderedList
- OverflowMenu
- OverflowMenuItem
- Pagination
- PaginationSkeleton
- ProgressIndicator
- ProgressIndicatorSkeleton
- ProgressStep
- RadioButton
- RadioButtonSkeleton
- RadioButtonGroup
- Search
- SearchSkeleton
- Select
- SelectSkeleton
- SelectItem
- SelectItemGroup
- SkeletonPlaceholder
- SkeletonText
- Slider
- SliderSkeleton
- StructuredList
- StructuredListSkeleton
- StructuredListBody
- StructuredListHead
- StructuredListCell
- StructuredListRow
- StructuredListInput
- StructuredListWrapper
- Tabs
- Tab
- TabContent
- TabsSkeleton
- Tag
- TagSkeleton
- TextArea
- TextAreaSkeleton
- TextInput
- TextInputSkeleton
- PasswordInput
- Tile
- ClickableTile
- SelectableTile
- ExpandableTile
- TileAboveTheFoldContent
- TileBelowTheFoldContent
- RadioTile
- Tile
- TileGroup
- RadioTile
- TimePicker
- TimePickerSelect
- Toggle
- ToggleSkeleton
- ToggleSmall
- ToggleSmallSkeleton
- Tooltip
- TooltipDefinition
- TooltipIcon
- UnorderedList
```bash
yarn add -D carbon-components-svelte
```
## Usage
```html
<script>
import { Button } from 'carbon-components-svelte';
</script>
<svelte:head>
<link
rel="stylesheet"
href="https://unpkg.com/carbon-components@10.9.0/css/carbon-components.min.css" />
</svelte:head>
<Button>Primary</Button>
```
Try it in the [CodeSandbox](https://codesandbox.io/s/carbon-components-svelte021-lhvc4).
## Contributing
@ -136,3 +44,8 @@ Refer to the [Contributing guidelines](CONTRIBUTING.md).
## License
[Apache 2.0](LICENSE)
[npm]: https://img.shields.io/npm/v/carbon-components-svelte.svg?color=blue
[npm-url]: https://npmjs.com/package/carbon-components-svelte
[build]: https://travis-ci.com/ibm/carbon-components-svelte.svg?branch=master
[build-badge]: https://travis-ci.com/ibm/carbon-components-svelte