react-slick README

The project's README from github.com/akiran/react-slick. As one markdown file: README.md.

react-slick

Backers on Open Collective Sponsors on Open Collective

Documentation

Installation

npm

npm install react-slick --save

yarn

yarn add react-slick

Also install slick-carousel for css and font

npm install slick-carousel

// Import css files
import "slick-carousel/slick/slick.css";
import "slick-carousel/slick/slick-theme.css";

or add cdn link in your html

<link
  rel="stylesheet"
  type="text/css"
  charset="UTF-8"
  href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.8.1/slick.min.css"
/>
<link
  rel="stylesheet"
  type="text/css"
  href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.8.1/slick-theme.min.css"
/>

PlayGround

Example

import React from "react";
import Slider from "react-slick";

export default function SimpleSlider() {
  var settings = {
    dots: true,
    infinite: true,
    speed: 500,
    slidesToShow: 1,
    slidesToScroll: 1
  };
  return (
    <Slider {...settings}>
      <div>
        <h3>1</h3>
      </div>
      <div>
        <h3>2</h3>
      </div>
      <div>
        <h3>3</h3>
      </div>
      <div>
        <h3>4</h3>
      </div>
      <div>
        <h3>5</h3>
      </div>
      <div>
        <h3>6</h3>
      </div>
    </Slider>
  );
}

Props

For all available props, go here.

Methods

For all available methods, go here

Development

Want to run demos locally

git clone https://github.com/akiran/react-slick
cd react-slick
npm install
npm start
open http://localhost:8080

Community

Join our discord channel to discuss react-slick bugs and ask for help

Contributing

Please see the contributing guidelines

react-slick (akiran/react-slick)

Searching Database…

11.9K ·GitHub
React-slick
Что это?react-slick — это компонент карусели для React, созданный как порт популярной библиотеки Slick Carousel.
Это UI-библиотека или полноценный фреймворк?Это библиотека с одним React-компонентом для показа каруселей и слайдеров, а не фреймворк.
Как мне добавить это в проект?Установите через npm или yarn, а затем также установите slick-carousel для CSS и файлов шрифтов (или подключите их через CDN в вашем HTML).
Нужны ли мне другие пакеты помимо самого react-slick?Да — помимо самого React, она зависит от classnames, json2mq, lodash.debounce и resize-observer-polyfill, а для стилей всё равно нужен отдельный пакет slick-carousel.
Есть ли подводные камни при установке, о которых мне стоит знать?CSS и шрифты не входят в состав самого react-slick, поэтому если пропустить установку slick-carousel или не подключить его CDN-файлы, карусель отобразится без нужного оформления и без иконок стрелок и точек.
Где посмотреть все настраиваемые пропсы и методы?В README есть ссылки на отдельные страницы со списком всех доступных пропсов и всех доступных методов, а также разделы PlayGround и Example, где можно попробовать библиотеку вживую.
Как запустить демо локально для разработки?Для разработки есть локальная среда запуска демо: в package.json есть скрипты вроде 'start' и 'demo', которые запускают сервер на базе gulp для просмотра примеров.
Где можно задать вопросы сообществу?Да, у проекта есть канал в Discord для обсуждения багов и получения помощи по react-slick.
What are similar projects?Semantic-UI-React, chakra-ui, Monocharts, material, material-ui, fluentui, react-dropzone, shaders
Which topics is it in?carousel, react-components, responsive, frontend-framework, design-system, component-library, javascript-library, ui-components, animation, ui, web-development, productivity
Creator
akiran
Size
2.3 MB
Stars
11.9K
Updated
CommitAug 07Release0.31.0Aug 07
Age
11y
Commits · 90 Days