A class that checks if an element is visible in the base element or viewport.
Download dist files from repo directly or install it via npm.
You can download the uncompressed files for development
- Latest : https://naver.github.io/egjs-visible/release/latest/dist/visible.js
- Specific version : https://naver.github.io/egjs-visible/release/[VERSION]/dist/visible.js
You can download the compressed files for production
- Latest : https://naver.github.io/egjs-visible/release/latest/dist/visible.min.js
- Specific version : https://naver.github.io/egjs-visible/release/[VERSION]/dist/visible.min.js
Packaged version is not an official distribution. Is just to provide for ease use of 'egjs-visible' with dependency.
-
Latest
-
Specific version
The following command shows how to install egjs-visible using npm.
$ npm install @egjs/visible
The following are the supported browsers.
Internet Explorer | Chrome | Firefox | Safari | iOS | Android |
---|---|---|---|---|---|
8+ | Latest | Latest | Latest | 7+ | 2.1+(except 3.x) |
egjs-visible has the dependencies for the following libraries:
egjs-component |
---|
2.0.0+ |
For anyone interested to develop egjs-visible, follow the instructions below.
Clone the egjs-visible repository and install the dependency modules.
# Clone the repository.
$ git clone https://github.com/naver/egjs-visible.git
npm
is supported.
# Install the dependency modules.
$ npm install
Use npm script to build billboard.js
# Run webpack-dev-server for development
$ npm start
# Build
$ npm run build
# Generate jsdoc
$ npm run jsdoc
Two folders will be created after complete build is completed.
- dist folder: Includes the visible.js and visible.min.js files.
- doc folder: Includes API documentation. The home page for the documentation is doc/index.html.
To keep the same code style, we adopted ESLint to maintain our code quality. The rules are modified version based on Airbnb JavaScript Style Guide. Setup your editor for check or run below command for linting.
$ npm run lint
Once you created a branch and done with development, you must perform a test running npm run test
command before you push code to a remote repository.
$ npm run test
Running a npm run test
command will start Mocha tests via Karma-runner.
If you find a bug, please report it to us using the Issues page on GitHub.
egjs-visible is released under the MIT license.
Copyright (c) 2015 NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.