react-native-star-rating-widget - GitLite

KO | EN

gitlite — search

#javascript #react #llm #golang #android #docker #nodejs #java #windows #awesome #cli #vue #ios #open-source

react-native-star-rating-widget

(★ 234)

A customizable, animated star rating component for React Native. Compatible with iOS, Android and Web. Written in Typescript.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- - adaptive-icon.png
  - favicon.png
  - icon.png
  - splash.png
- - .gitignore
  - .xcode.env
  - Podfile
  - Podfile.lock
  - Podfile.properties.json
- - App.tsx
  - BasicExample.tsx
  - ClearOnCurrentRatingTapExample.tsx
  - CustomIconExample.tsx
  - ExampleContainer.tsx
  - StarRatingDisplayExample.tsx
  - StepPropExample.tsx
- App.js
- app.json
- babel.config.js
- metro.config.js
- package.json
- tsconfig.json
- yarn.lock
- demo.gif
- bootstrap.js
- - utils.test.ts
- index.ts
- StarIcon.tsx
- StarRating.tsx
- StarRatingDisplay.tsx
- utils.ts
.editorconfig
.gitattributes
.gitignore
.nvmrc
.watchmanconfig
.yarnrc
babel.config.js
CODE_OF_CONDUCT.md
CONTRIBUTING.md
lefthook.yml
LICENSE
package.json
README.md
tsconfig.build.json
tsconfig.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/bviebahn/react-native-star-rating-widget

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd react-native-star-rating-widget

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# react-native-star-rating-widget

[![npm version](https://badge.fury.io/js/react-native-star-rating-widget.svg)](https://badge.fury.io/js/react-native-star-rating-widget)

A customizable, animated star rating component for React Native. Compatible with iOS, Android and Web. Written in Typescript.

![Demo](https://github.com/benediktviebahn/react-native-star-rating-widget/raw/master/media/demo.gif)

## Installation

1. install react-native-star-rating-widget
   `npm install react-native-star-rating-widget --save` or `yarn add react-native-star-rating-widget`
2. if not already installed, add [react-native-svg](https://github.com/react-native-community/react-native-svg)

## Usage

This package exports an

### Interactive `StarRating` component

```js
import StarRating from 'react-native-star-rating-widget';

const Example = () => {
  const [rating, setRating] = useState(0);
  return <StarRating rating={rating} onChange={setRating} />;
};
```

### Non-Interactive `StarRatingDisplay` component

```js
import { StarRatingDisplay } from 'react-native-star-rating-widget';

const Example = () => {
  return <StarRatingDisplay rating={4.5} />;
};
```

See [example/src](example/src) for more examples.

## Props

### `StarRating` Props

| Name                         | Type                                                                                                       | Default                                                                                              | Description                                                     |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| rating                       | number                                                                                                     | **REQUIRED**                                                                                         | Rating Value. Should be between 0 and `maxStars`                |
| onChange                     | (rating: number) => void                                                                                   | **REQUIRED**                                                                                         | called when rating changes                                      |
| maxStars                     | number                                                                                                     | 5                                                                                                    | number of stars                                                 |
| starSize                     | number                                                                                                     | 32                                                                                                   | star size                                                       |
| color                        | string                                                                                                     | "#fdd835"                                                                                            | star color                                                      |
| emptyColor                   | string                                                                                                     | same as `color`                                                                                      | empty star color                                                |
| style                        | object                                                                                                     | undefined                                                                                            | optional style                                                  |
| starStyle                    | object                                                                                                     | undefined                                                                                            | optional star style                                             |
| starContainerStyle           | object                                                                                                     | undefined                                                                                            | optional star container style                                   |
| step                         | "full" \| "half" \| "quarter"                                                                              | "half"                                                                                               | step size for rating - full stars, half stars, or quarter stars |
| enableSwiping                | boolean                                                                                                    | true                                                                                                 | enable or disable swiping                                       |
| onRatingStart                | (rating: number) => void                                                                                   | undefined                                                                                            | called when the interaction starts, before `onChange`           |
| onRatingEnd                  | (rating: number) => void                                                                                   | undefined                                                                                            | called when the interaction starts, after `onChange`            |
| animationConfig              | see [AnimationConfig](#animationConfig)                                                                    | see [AnimationConfig](#animationConfig)                                                              | animation configuration object                                  |
| StarIconComponent            | (props: { index: number; size: number; color: string; type: "full" \| "half" \| "empty"; }) => JSX.Element | [StarIcon](https://github.com/bviebahn/react-native-star-rating-widget/blob/master/src/StarIcon.tsx) | Icon component                                                  |
| accessibilityLabel           | string                                                                                                     | star rating. %value% stars. use custom actions to set rating.                                        | The label used on the star component                            |
| accessabilityIncrementLabel  | string                                                                                                     | increment                                                                                            | The label for the increment action                              |
| accessabilityDecrementLabel  | string                                                                                                     | decrement                                                                                            | The label for the decrement action.                             |
| accessabilityActivateLabel   | string                                                                                                     | activate (default)                                                                                   | The label for the activate action.                              |
| accessibilityAdjustmentLabel | string                                                                                                     | %value% stars                                                                                        | The label that is announced after adjustment action             |

### `StarRatingDisplay` Props

The `StarRatingDisplay` component accepts mostly the same props as `StarRating` except those that are interaction related props such as `onChange`, `enableSwiping`, `onRatingStart` etc.

### AnimationConfig

| Name     | Type               | Default           | Description                                |
| -------- | ------------------ | ----------------- | ------------------------------------------ |
| scale    | number             | 1.2               | star animation scale value                 |
| duration | number             | 300               | animation duration                         |
| delay    | number             | 300               | animation delay when interaction has ended |
| easing   | (number) => number | Easing.elastic(2) | animation easing function                  |