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 库的 React 移植版本。
它是 UI 库还是完整的框架？它是一个专注于渲染轮播图和滑块的单一 React 组件库，而不是框架。
我该如何把它加入项目？通过 npm 或 yarn 安装它，然后再安装 slick-carousel 以获取 CSS 和字体资源（或者在 HTML 中通过 CDN 引入这些资源）。
除了 react-slick 本身，我还需要其他包吗？需要。除了 React 本身，它还依赖 classnames、json2mq、lodash.debounce 和 resize-observer-polyfill，并且你仍然需要单独的 slick-carousel 包来提供样式。
安装时有哪些需要注意的坑吗？react-slick 本身不包含 CSS 和字体。如果你跳过安装 slick-carousel，或者不引入它的 CDN 资源，轮播图将无法正常显示样式，箭头和圆点图标也会缺失。
所有可配置的 props 和方法在哪里能看到？README 中提供了专门的页面，分别列出所有可用的 props 和所有可用的方法，还有 PlayGround 和 Example 部分可以在线试用。
如何在本地运行演示进行开发？项目提供了本地开发环境用于运行演示；package.json 中包含 'start' 和 'demo' 等脚本，可启动一个基于 gulp 的服务器来预览示例。
有没有可以提问的社区？有，项目有一个 Discord 频道，可以讨论 bug 并获取 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