0.0.7 • Published 2 years ago

@xiul/xdv-carousel-basic v0.0.7

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

\

This webcomponent follows the open-wc recommendation.

Installation

npm i @xiul/xdv-carousel-basic

Usage

<script type="module">
  import '@xiul/xdv-carousel-basic/xdv-carousel-basic.js';
</script>

<xdv-carousel-basic></xdv-carousel-basic>

Use the component.

Properties

  <xdv-carousel 
    slideUrls='urls900'
    id='carousel_b'
  >
  </xdv-carousel>

CSS Custom Properties

Slider ContainerDescriptionDefault
--xdv-slider-container-gapGap0
--xdv-slider-container-max-heightMax height carousel25rem
--xdv-slider-border-radiusCarousel border radius1rem
Slider BottonsDescriptionDefault
--xdv-slider-btn-colorBtn color#000
--xdv-slider-btn-bgBtn background#fff
--xdv-slider-btn-positionBtn position right/left1rem
--xdv-slider-btn-hover-scaleBtn hover scale1.1
--xdv-slider-btn-hover-colorBtn hover color#000
--xdv-slider-btn-hover-bgBtn hover background#fff
DotsDescriptionDefault
--xdv-slider-dots-bottom-positionBottom position0.25rem
--xdv-slider-dot-bgDots background color#f5f2f2
--xdv-slider-dot-bg-hoverDots hover/selected background#d89999
@media screen and (max-width: 900px)DescriptionDefault
--xdv-slider-container-max-heightMax height carousel15rem

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode run:

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to minimize the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html