Skip to content

Commit

Permalink
Merge branch 'develop' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
odahcam authored May 10, 2018
2 parents ee1724c + 1218a60 commit 726144c
Show file tree
Hide file tree
Showing 18 changed files with 12,114 additions and 5,534 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,6 @@ Thumbs.db

# ng-packagr
.ng_pkg_build
*.tgz
*.tar
*.tar.gz
9 changes: 9 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,12 @@ node_js:
- '8.4.0'
addons:
chrome: stable
script:
- npm i -g npm-install-peers
- npm-install-peers
- npm run lint
- npm run test
# - npm run e2e
- npm run docs:build
- npm run build:prod
- npm run build:packagr
10 changes: 7 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@
"version": "0.2.0",
"configurations": [
{
"name": "ng serve",
"type": "chrome",
"request": "launch",
"url": "http://localhost:4200/",
"webRoot": "${workspaceRoot}"
"name": "ng serve",
"url": "http://localhost:4200",
"webRoot": "${workspaceRoot}",
"preLaunchTask": "ngserve",
"runtimeArgs": [
"--remote-debugging-port=9222"
]
},
{
"name": "ng test",
Expand Down
40 changes: 40 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "start",
"problemMatcher": [
"$tsc"
]
},
{
"label": "ngserve",
"type":"shell",
"command": "ng",
"args": [
"serve"
],
"isBackground": true,
"problemMatcher": [
{
"pattern": [
{
"regexp": "\\b\\B|EXEPTION|Type Error|Error ",
"file": 1,
"location": 2,
"message": 3
}
],
"background": {
"activeOnStart": false,
"beginsPattern": "^.*NG Live Development Server is listening*",
"endsPattern": "^.*webpack: Compiled successfully.*"
}
}
]
}
]
}
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
153 changes: 0 additions & 153 deletions README.MD

This file was deleted.

83 changes: 83 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<p align="center">

<a href="https://github.com/zxing-js/library">
<img src="https://user-images.githubusercontent.com/3942006/39460928-a44b0f92-4cdd-11e8-849b-4d34db99113a.png">
</a>

<h3 align="center">@zxing/ngx-scanner</h3>

<p align="center">
Angular QR-Code scanner component.
<br>
<br>
<a href="https://github.com/zxing-js/ngx-scanner/issues/new?template=bug.md">Report a bug</a>
·
<a href="https://github.com/zxing-js/ngx-scanner/issues/new?template=feature.md&labels=feature">Request feature</a>
</p>
</p>


[![NPM version](https://img.shields.io/npm/v/@zxing/ngx-scanner.svg?&label=npm)](https://www.npmjs.com/package/@zxing/ngx-scanner )
[![Downloads](https://img.shields.io/npm/dm/@zxing/ngx-scanner.svg)](https://npmjs.org/package/@zxing/ngx-scanner )
[![Dependency Status](https://david-dm.org/werthdavid/ngx-scanner.svg)](https://david-dm.org/werthdavid/ngx-scanner)
[![Build Status](https://travis-ci.org/zxing-js/ngx-scanner.svg?branch=master)](https://travis-ci.org/zxing-js/ngx-scanner)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/fba14393a17241088f75b19edc370694)](https://www.codacy.com/app/zxing-js/ngx-scanner?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=zxing-js/ngx-scanner&amp;utm_campaign=Badge_Grade)
[![Join the chat at https://gitter.im/zxing-js/ngx-scanner](https://badges.gitter.im/zxing-js/ngx-scanner.svg)](https://gitter.im/zxing-js/ngx-scanner?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


## Features & Hints

- Supports continuous scanning.
- Supports iOS 11 (only in Safari via HTTPS --> see `Limitations` below).
- There is a configurable delay of 1500ms after each successful scan, before a new QR-Code can be detected.
- Nice devs behind it. 🤓


## Demo

> Previews needs to be opened in new standalone windows.
- [Demo](https://zxing-js.github.io/ngx-scanner/)
- [StackBlitz](https://zxing-ngx-scanner.stackblitz.io/)
- [Plunkr](https://embed.plnkr.co/MN4riU/) (click open preview in separate window)


## How To

**We've built a veeeery cool Wiki for you! [Click here to take a look!](/zxing-js/ngx-scanner/wiki)**

I promise that it's **very** simple to use:
```html
<!-- some.component.html -->
<zxing-scanner></zxing-scanner>
```


## API

| Method | Parameters | Returns | Description |
|---------------------|------------------------------------------------|----------------------------------|--------------------------------------------------------------|
| **changeDevice** | `device: MediaDeviceInfo` | `void` | Allows you to properly change the scanner device on the fly. |
| **camerasFound** | `callback: (devices: MediaDeviceInfo[]`) => {} | `EventEmitter<MediaDeviceInfo >` | Emits an event when cameras are found. |
| **camerasNotFound** | `callback: (): void => {}` | `EventEmitter<void>` | Emits an event when cameras are not found. |
| **scanSuccess** | `callback: (result: string): void => {}` | `EventEmitter<string>` | Emits an event when a scan is successful performed. |
| **scanFailure** | `callback: (): void => {}` | `EventEmitter<void>` | Emits an event when a scan fails. |
| **scanError** | `callback: (error: any): void => {}` | `EventEmitter<any>` | Emits an event when a scan throws an error. |


## Performance

Read our performance notes on the wiki: [Performance Considerations](https://github.com/zxing-js/ngx-scanner/wiki/Performance-Considerations).


## Limitations

- The component relies on [zxing-typescript](https://github.com/zxing-web/library) which currently supports totally the following code formats:
- QR Code
- Code 128
- On iOS <= 11.2 devices camera access works only in native Safari. **This is limited WebRTC support by Apple.**


## Generator

Looking for a way to generate QR-Codes? Check-out [ngx-kjua](https://github.com/werthdavid/ngx-kjua)
3 changes: 2 additions & 1 deletion ngx-zxing.iml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<!-- IntelliJ project file -->
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
Expand All @@ -9,4 +10,4 @@
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>
</module>
Loading

0 comments on commit 726144c

Please sign in to comment.