Skip to content

Commit

Permalink
feat: added layout measured event to detech scaning area and some new…
Browse files Browse the repository at this point in the history
… props

Added `onLayoutMeasured` event to detect scanning area and three new properties `outerMaskOpacity`,
`animatedLineWidth` and `animatedLineOrientation`

fix #14, pr #15, pr #13
  • Loading branch information
shahnawaz committed May 2, 2020
1 parent 0b5401a commit 8fd9c20
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 88 deletions.
46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# react-native-barcode-mask

![version](https://img.shields.io/npm/v/react-native-barcode-mask.svg?style=flat-square)
![dependencies](https://img.shields.io/david/shahnawaz/react-native-barcode-mask.svg?style=flat-square)
![download](https://img.shields.io/npm/dt/react-native-barcode-mask?style=flat-square)
![licence](https://img.shields.io/npm/l/react-native-barcode-mask.svg?style=flat-square)
![dependencies](https://img.shields.io/david/shahnawaz/react-native-barcode-mask.svg?style=flat-square)

> :camera: A barcode and QR code scan layout for react-native applications with customizable styling
Expand Down Expand Up @@ -71,7 +72,7 @@ Few style modifications:
<BarcodeMask edgeColor={'#62B1F6'} showAnimatedLine={false}/>

// Barcode example 2
<BarcodeMask width={100} height={300} showAnimatedLine={false} transparency={0.8}/>
<BarcodeMask width={100} height={300} showAnimatedLine={false} outerMaskOpacity={0.8}/>

// Barcode example 3
<BarcodeMask width={300} height={100} edgeBorderWidth={1} />
Expand All @@ -83,73 +84,90 @@ Few style modifications:

#### `width`

Value: number | string (`%`)
Value: `number` | `string` (`%`)
Default: `280`

Finder's width (the visible area)

#### `height`

Value: number | string (`%`)
Value: `number` | `string` (`%`)
Default: `230`

Finder's height (the visible area)

#### `edgeWidth`

Value: number | string (`%`)
Value: `number` | `string` (`%`)
Default: `20`

Edge/Corner's width

#### `edgeHeight`

Value: number | string (`%`)
Value: `number` | `string` (`%`)
Default: `20`

Edge/Corner's height

#### `edgeColor`

Value: string
Value: `string`
Default: `#FFF`

Use this to give custom color to edges

#### `edgeBorderWidth`

Value: number | string (`%`)
Value: `number` | `string` (`%`)
Default: `4`

Use this to modify the border (thickness) of edges

#### `backgroundColor`

Value: string `rgba(0, 0, 0, 0.6)`
Default: `rgba(0, 0, 0, 0.6)`
Value: `string`
Default: `rgb(0, 0, 0, 0.6)`

Use this to modify the background color of area around finder

#### `outerMaskOpacity`

Value: `number` (0 - 1)
Default: 0.6

Use this to modify the transparency of outer mask

#### `showAnimatedLine`

Value: boolean `true` | `false`
Value: `boolean`
Default: `true`

#### `animatedLineColor`

Value: string
Value: `string`
Default: `#FFF`

#### `animatedLineHeight`

Value: number
Value: `number`
Default: `2`

#### `animatedLineWidth`

Value: `number` | `string` (`%`)
Default: `85%`

#### `lineAnimationDuration`

Value: number
Value: `number`
Default: `1500`

#### `animatedLineOrientation`

Value: `string` (`horizontal` | `vertical`)
Default: `horiontal`

## Contribution

Want to add some new styles or layout?
Expand Down
6 changes: 5 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ export interface BarcodeMaskProps {
edgeColor?: string;
edgeBorderWidth?: number | string;
backgroundColor?: string;
outerMaskOpacity?: number;
showAnimatedLine?: boolean;
animatedLineColor?: string;
animatedLineHeight?: number;
animatedLineHeight?: number | string;
animatedLineWidth?: number | string,
lineAnimationDuration?: number;
animatedLineOrientation?: PropTypes.string;
onLayoutMeasured: PropTypes.func;
}

declare class BarcodeMask extends Component<BarcodeMaskProps, {}> {}
Expand Down

0 comments on commit 8fd9c20

Please sign in to comment.