UNPKG

react-animarker

Version:
58 lines 2.21 kB
{ "name": "react-animarker", "version": "3.0.13", "description": "Animated mark tags on scroll", "main": "dist/index.js", "types": "dist/index.d.ts", "repository": { "type": "git", "url": "git+https://github.com/kezant/react-animarker.git" }, "keywords": [ "Mark", "React", "Animarker", "Scroll", "Highlight" ], "author": "keznet", "license": "ISC", "bugs": { "url": "https://github.com/kezant/react-animarker/issues" }, "homepage": "https://github.com/kezant/react-animarker#readme", "devDependencies": { "@testing-library/react": "^13.4.0", "@types/jest": "^29.2.3", "@types/node": "20.4.5", "@types/react": "18.2.18", "@typescript-eslint/eslint-plugin": "^5.44.0", "@typescript-eslint/parser": "^5.44.0", "eslint-plugin-jsdoc": "^39.6.4", "eslint-plugin-prefer-arrow": "^1.2.3", "eslint-plugin-react": "^7.31.11", "jest": "^29.3.1", "prettier": "^2.7.1", "react": "18.2.0", "ts-jest": "^29.0.3", "tsconfig": "0.0.0", "typescript": "5.1.6" }, "files": [ "dist/**/*" ], "dependencies": { "hookez": "^1.0.71" }, "scripts": { "test": "jest --config jestconfig.json --passWithNoTests", "test:ci": "jest --ci --reporters='default' --config jestconfig.json --passWithNoTests", "build": "tsc", "format": "prettier --write \"src/**/*.ts\"", "lint": "eslint -c .eslintrc --ext .ts,.tsx ./src", "preversion": "npm run lint", "version": "npm run format && git add -A src", "postversion": "git push && git push --tags" }, "readme": "# React Animarker\n\n![Tests CI](https://github.com/keznet/react-animarker/actions/workflows/tests.yml/badge.svg)\n\nAnimarker is a \\<mark\\> component that animates once in the viewport.\n\n## Getting Started\n\n**Installation**\n\n```\nnpm i react-animarker\n```\n\nOr, if you are using yarn:\n\n```\nyarn add react-animarker\n```\n\n**Usage**\n\nImport the component and use it as a regular mark tag. Eg.:\n\n```js\nimport { Animarker } from \"react-animarker\";\n```\n\n**Types**\n\nReact Animarker was built on Typescript, so types are included in the package without the need to add extra types.\n" }