@xiul/xdv-carousel-basic

<xdv-carousel-basic>

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 Container	Description	Default
--xdv-slider-container-gap	Gap	0
--xdv-slider-container-max-height	Max height carousel	25rem
--xdv-slider-border-radius	Carousel border radius	1rem

Slider Bottons	Description	Default
--xdv-slider-btn-color	Btn color	#000
--xdv-slider-btn-bg	Btn background	#fff
--xdv-slider-btn-position	Btn position right/left	1rem
--xdv-slider-btn-hover-scale	Btn hover scale	1.1
--xdv-slider-btn-hover-color	Btn hover color	#000
--xdv-slider-btn-hover-bg	Btn hover background	#fff

Dots	Description	Default
--xdv-slider-dots-bottom-position	Bottom position	0.25rem
--xdv-slider-dot-bg	Dots background color	#f5f2f2
--xdv-slider-dot-bg-hover	Dots hover/selected background	#d89999

@media screen and (max-width: 900px)	Description	Default
--xdv-slider-container-max-height	Max height carousel	15rem

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