Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
dohooo committed Nov 25, 2023
2 parents 4ca43c6 + 55ae153 commit 5cd30ad
Show file tree
Hide file tree
Showing 11 changed files with 1,283 additions and 456 deletions.
46 changes: 46 additions & 0 deletions example/website/components/Badges.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
export const Badges = () => {
return (
<div style={{ display: "flex", flexDirection: "row", flexWrap: "wrap", marginTop: 12, justifyContent: "center" }}>
{
[
{
label: "Hacktober Badge",
url: "https://img.shields.io/badge/hacktoberfest-2022-blueviolet",
},
{
label: "platforms",
url: "https://img.shields.io/badge/platforms-Android%20%7C%20iOS%20%7C%20Web-brightgreen.svg?style=flat-square&colorB=191A17",
},
{
label: "npm",
url: "https://img.shields.io/npm/v/react-native-reanimated-carousel.svg?style=flat-square",
},
{
label: "npm",
url: "https://img.shields.io/npm/dm/react-native-reanimated-carousel.svg?style=flat-square&colorB=007ec6",
},
{
label: "npm",
url: "https://img.shields.io/npm/dw/react-native-reanimated-carousel.svg?style=flat-square&colorB=007ec6",
},
{
label: "github issues",
url: "https://img.shields.io/github/issues/dohooo/react-native-reanimated-carousel.svg?style=flat-square",
},
{
label: "github closed issues",
url: "https://img.shields.io/github/issues-closed/dohooo/react-native-reanimated-carousel.svg?style=flat-square&colorB=44cc11",
},
{
label: "discord chat",
url: "https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord",
},
].map((badge, index) => {
return (
<img src={badge.url} alt={badge.label} key={index} style={{ marginRight: 5, marginBottom: 8 }} />
);
})
}
</div>
);
};
10 changes: 5 additions & 5 deletions example/website/next.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const withNextra = require('nextra')({
theme: 'nextra-theme-docs',
themeConfig: './theme.config.tsx',
})
const withNextra = require("nextra")({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
});

module.exports = withNextra()
module.exports = withNextra();
4 changes: 2 additions & 2 deletions example/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
"homepage": "https://github.com/shuding/nextra-docs-template#readme",
"dependencies": {
"next": "^13.0.6",
"nextra": "latest",
"nextra-theme-docs": "latest",
"nextra": "2.13.2",
"nextra-theme-docs": "2.13.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
8 changes: 1 addition & 7 deletions example/website/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
{
"index": "Introduction",
"another": "Another Page",
"advanced": "Advanced (A Folder)",
"about": {
"title": "About",
"type": "page"
},
"contact": {
"title": "Contact ↗",
"type": "page",
"href": "https://twitter.com/shuding_",
"href": "https://twitter.com/caspian_1016",
"newWindow": true
}
}
88 changes: 82 additions & 6 deletions example/website/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,87 @@
# Introduction
---
id: getting-started
title: Getting Started
sidebar_label: Getting Started
description: A performant interactive bottom sheet with fully configurable options 🚀
keywords:
- react-native-reanimated-carousel
- reanimated-carousel
- reanimated carousel
- react-native
- snap-carousel
- react native
- snap carousel
- ios
- android
- carousel
- snap
- reanimated
image: /img/bottom-sheet-preview.gif
slug: /
---

# React Native Reanimated Carousel

import { Badges } from '../components/Badges'
import { Callout } from 'nextra/components'

Welcome to Nextra! This is a basic docs template. You can use it as a starting point for your own project :)
<div style={{borderRadius:"8px",overflow:"hidden"}}>
![Cover Image](../../../assets/home-banner.png)
</div>
<Badges />

A performant carousel for React Native powered by Reanimated. ⚡️

## Features

- The best performance you can get. 🚀
- Fully configurable. ⚙️
- Support for both `iOS` & `Android` & `Web`. 📱
- Support for `RTL` layout. 🌍
- Smooth gesture interactions & snapping animations. 🏎
- Support to customise the animation style. 🎨
- Compatible with Reanimated [v1]() & [v2](). 🎉
- Compatible with `Expo`. 🎩
- Accessibility support. ♿️
- Written in `TypeScript`. 🌳

## Installation

```bash
yarn add react-native-reanimated-carousel
```

#### Dependencies

This library needs these dependencies to be installed in your project before you can use it:

```bash
yarn add react-native-reanimated react-native-gesture-handler
```

Using Expo?

```bash
expo install react-native-reanimated react-native-gesture-handler
```

<Callout emoji="⚠️">
**React Native Gesture Handler** needs extra steps to finalize its installation, please follow their [installation instructions](https://docs.swmansion.com/react-native-gesture-handler/docs/installation). Please **make sure** to wrap your App with `GestureHandlerRootView` when you've upgraded to React Native Gesture Handler ^2.

**React Native Reanimated v2** needs extra steps to finalize its installation, please follow their [installation instructions](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started).
</Callout>

## Sponsor & Support

To keep this library maintained and up-to-date please consider sponsoring to as. ☕️

## What is Nextra?
- [Caspian](https://github.com/sponsors/dohooo)
- [Oliver Lopez](https://github.com/sponsors/oliverloops)

A **simple**, **powerful** and **flexible** site generation framework with everything you love from Next.js.

## Documentation
## Built With ❤️

The documentation is available at [https://nextra.site](https://nextra.site).
- [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated)
- [react-native-gesture-handler](https://github.com/software-mansion/react-native-gesture-handler)
- [react-native-redash](https://github.com/wcandillon/react-native-redash)
- [react-native-builder-bob](https://github.com/callstack/react-native-builder-bob)
Loading

0 comments on commit 5cd30ad

Please sign in to comment.