Merge pull request #105 from IBM/docs

docs: release v0.2.0, v0.2.1
This commit is contained in:
Eric Liu 2020-01-08 07:47:19 -08:00 committed by GitHub
commit 07d97da8a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 55 additions and 127 deletions

1
.prettierignore Normal file
View file

@ -0,0 +1 @@
README.md

View file

@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.2.1](https://github.com/IBM/carbon-components-svelte/releases/tag/v0.2.1) - 2020-01-08
- Check if `l10n.en` is defined in `DatePicker` component to resolve Svelte REPL compilation
## [0.2.0](https://github.com/IBM/carbon-components-svelte/releases/tag/v0.2.0) - 2020-01-08
- Include `src` in files published to npm to resolve Svelte module entry
([#102](https://github.com/IBM/carbon-components-svelte/issues/102))
- Support most Carbon components (See the [GitHub project](https://github.com/IBM/carbon-components-svelte/projects/1))
## [0.1.0](https://github.com/IBM/carbon-components-svelte/releases/tag/v0.1.0) - 2019-12-15
- Initial release

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
- ComboBox
- ComposedModal
- ModalHeader
- ModalBody
- ModalFooter
- ContentSwitcher
- Switch
- Copy
- CopyButton
- DataTable
- DataTableSkeleton
- DatePicker
- DatePickerInput
- FileUploader
- FileUploaderButton
- FileUploaderItem
- FileUploaderDropContainer
- Filename
- Form
- FormGroup
- FormItem
- FormLabel
- Icon
- IconSkeleton
- InlineLoading
- Link
- ListBox
- ListBoxField
- ListBoxMenu
- ListBoxMenuIcon
- ListBoxMenuItem
- ListBoxSelection
- ListItem
- Loading
- MultiSelect
- 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
- Tabs
- Tab
- TabContent
- TabsSkeleton
- Tag
- TagSkeleton
- TextArea
- TextAreaSkeleton
- TextInput
- TextInputSkeleton
- PasswordInput
- Tile
- ClickableTile
- SelectableTile
- ExpandableTile
- 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

View file

@ -1,6 +1,6 @@
{
"name": "carbon-components-svelte",
"version": "0.1.0",
"version": "0.2.1",
"license": "Apache-2.0",
"description": "Svelte implementation of the Carbon Design System",
"svelte": "src/index.js",
@ -124,7 +124,8 @@
"svelte"
],
"files": [
"lib"
"lib",
"src"
],
"bugs": "https://github.com/ibm/carbon-components-svelte/issues"
}

View file

@ -1,12 +1,14 @@
import flatpickr from 'flatpickr';
import l10n from 'flatpickr/dist/l10n';
import l10n from 'flatpickr/dist/l10n/index.js';
import rangePlugin from 'flatpickr/dist/plugins/rangePlugin';
import { cx } from '../../lib';
l10n.en.weekdays.shorthand.forEach((_, index) => {
const shorthand = _.slice(0, 2);
l10n.en.weekdays.shorthand[index] = shorthand === 'Th' ? 'Th' : shorthand.charAt(0);
});
if (l10n.en) {
l10n.en.weekdays.shorthand.forEach((_, index) => {
const shorthand = _.slice(0, 2);
l10n.en.weekdays.shorthand[index] = shorthand === 'Th' ? 'Th' : shorthand.charAt(0);
});
}
function updateClasses(instance) {
const { calendarContainer, days, daysContainer, weekdayContainer, selectedDates } = instance;