@bootcamp-project/sveltelizer
v1.4.0
Published
Ready-to-use Svelte Library with Tailwind CSS and TypeScript support by default
Downloads
184
Maintainers
Readme
Modern Svelte Components Library
with Tailwind-CSS and TypeScript Support by default
🦄 About 🦄
Provide a Svelte Library with modern components for front-end projects
Project Links
Minimum Viable Product: What is what we want?
- [ ] Container
- [ ] Row
- [ ] Col
- [ ] Typography
- [x] H1 - H6
- [ ] Button
- [ ] ButtonDropdown
- [ ] ButtonGroup
- [ ] ButtonGroupItem
- [ ] ButtonToolbar
- [ ] Divider
- [ ] Textarea
- [ ] Select
- [ ] Checkbox
- [ ] Radio
- [ ] Radiobutton
- [ ] Switch
- [ ] Input
- [ ] InputGroup
- [ ] InputGroupText
- [ ] Dropdown
- [ ] DropdownItem
- [ ] DropdownMenu
- [ ] DropdownToggle
- [ ] TextField
- [ ] List
- [ ] ListGroup
- [ ] ListGroupItem
- [ ] ListItem
- [ ] ListItemGroup
- [ ] Form
- [ ] FormCheck
- [ ] FormFeedback
- [ ] FormGroup
- [ ] FormText
- [ ] Formfield
🚀 Getting Started 🚀
💪 Installation 💪
npm install @bootcamp-project/sveltelizer
# or
yarn add @bootcamp-project/sveltelizer
🤩 Usage 🤩
<script lang="ts">
import H1 from "$lib/Typography/H1.svelte";
</script>
<h1>Hello world!</h1>
Create new Component
- [ ] New Svelte File
- [ ] HTML Templete Element (like:
<button>
,<div>
and so on) - [ ] Need the component to pass data? (Use:
<slot />
) - [ ] Declaire all needed
props
of the component (HTML element attributes) - [ ] Declaire the class (HTML element classes)
⭐️ Features ⭐️
- Svelte UI Library and Tailwind CSS by default
- Automatic CI/CD Pipeline for GitLab by default
- Browser / Node.js and TypeScript support by default
- Test-Diven Development and Unit-Tests by default
- Best pratice and security-first Linting and Prettier by default
- Security-first production ready configuration by default
- Extensive configuration documentation
😎 Built With 😎
📑 Changelog 📑
See CHANGELOG for more information.
📋 Roadmap 📋
- [ ] Figure
- [ ] Image
- [ ] Icon
- [ ] Avatar
- [ ] Badge
- [ ] Chip
- [ ] Breadcrumb
- [ ] BreadcrumbItem
- [ ] Fileinput
- [ ] Timepicker
- [ ] Datepicker
- [ ] Starrating
- [ ] Slider
- [ ] SlideGroup
- [ ] SlideItem
- [ ] Card
- [ ] CardActions
- [ ] CardBody
- [ ] CardColumns
- [ ] CardDeck
- [ ] CardFooter
- [ ] CardGroup
- [ ] CardHeader
- [ ] CardImg
- [ ] CardImgOverlay
- [ ] CardLink
- [ ] CardSubtitle
- [ ] CardText
- [ ] CardTitle
- [ ] Table
- [ ] Column
- [ ] Row
- [ ] DataTable
- [ ] DataTableBody
- [ ] DataTableCell
- [ ] DataTableHead
- [ ] DataTableRow
- [ ] Pagination
- [ ] PaginationItem
- [ ] PaginationLink
- [ ] Collapse
- [ ] Accordion
- [ ] AccordionHeader
- [ ] AccordionItem
- [ ] Carousel
- [ ] CarouselCaption
- [ ] CarouselControl
- [ ] CarouselIndicators
- [ ] CarouselItem
- [ ] Tab
- [ ] TabContent
- [ ] TabPane
- [ ] Tabs
- [ ] Nav
- [ ] NavItem
- [ ] NavLink
- [ ] Navbar
- [ ] NavbarBrand
- [ ] NavbarToggler
- [ ] Popover
- [ ] Tooltip
- [ ] Alert
- [ ] Toast
- [ ] ToastBody
- [ ] ToastHeader
- [ ] Modal
- [ ] ModalBackdrop
- [ ] ModalBody
- [ ] ModalFooter
- [ ] ModalHeader
- [ ] NavigationDrawer
- [ ] AppBar
- [ ] Autocomplete
- [ ] ClickOutside
- [ ] Closebutton
- [ ] Dialog
- [ ] Dot
- [ ] ExpansionPanel
- [ ] Fade
- [ ] Footer
- [ ] InlineContainer
- [ ] Intersect
- [ ] ItemGroup
- [ ] Jumbotron
- [ ] Jump
- [ ] Label
- [ ] Lazy
- [ ] Loading
- [ ] Menu
- [ ] Overlay
- [ ] Offcanvas
- [ ] OffcanvasBackdrop
- [ ] OffcanvasBody
- [ ] OffcanvasHeader
- [ ] Placeholders
- [ ] Portal
- [ ] Progress
- [ ] ProgressCircular
- [ ] ProgressLinear
- [ ] Ripple
- [ ] Scrollspy
- [ ] Snackbar
- [ ] Spinner
- [ ] Styles
- [ ] Subheader
- [ ] Touch
- [ ] Utils
- [ ] VirtualList
- [ ] Window
- [ ] WindowItem
See the open issues for a list of proposed features (and known issues).
🤝 Contribute 🤝
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
Please read the contribution guidelines first.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
🏆 Acknowledgements 🏆
Thanks for these awesome resources that were used during the development of the Bootcamp: Svelte Components Library:
📜 License 📜
See LICENSE for more information.
💌 Contact 💌
Bootcamp contributors - contributors
@ bootcamp-project
.com