https://github.com/box/box-annotations
JavaScript library for annotations on files rendered with Box Content Preview
https://github.com/box/box-annotations
Last synced: 7 months ago
JSON representation
JavaScript library for annotations on files rendered with Box Content Preview
- Host: GitHub
- URL: https://github.com/box/box-annotations
- Owner: box
- License: other
- Created: 2017-08-18T18:12:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T11:09:47.000Z (over 1 year ago)
- Last Synced: 2025-03-21T22:03:29.994Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://app.box.com
- Size: 4.45 MB
- Stars: 11
- Watchers: 21
- Forks: 48
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](http://opensource.box.com/badges)
[](https://mergify.io)
[](https://github.com/prettier/prettier)
[](https://travis-ci.com/box/box-annotations)
[](https://www.npmjs.com/package/box-annotations)
# [Box Annotations](https://support.box.com/hc/en-us/articles/360048016153-Annotating-Documents)
Box Annotations allows users to add markup on top of content displayed by [Box Content Preview](https://developer.box.com/docs/box-content-preview). Annotations improve collaboration by allowing users to draw attention and leave specific feedback on specific areas of a document or image. The library currently supports several [annotation types](https://support.box.com/hc/en-us/articles/360059971834-Document-and-Image-Files-You-Can-Annotate) which can vary based on the type of file being previewed.
## Browser Support
- Desktop: Chrome, Firefox, Safari, Edge (Chromium), and Internet Explorer 11
- Mobile: Android Chrome, iOS Safari,
## Supported Locales
`en-AU`, `en-CA`, `en-GB`, `en-US`, `bn-IN`, `da-DK`, `de-DE`, `es-419`, `es-ES`, `fi-FI`, `fr-CA`, `fr-FR`, `hi-IN`,`it-IT`, `ja-JP`, `ko-KR`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `ru-RU`, `sv-SE`, `tr-TR`, `zh-CN`, `zh-TW`
## Usage
Box Annotations is a plugin and **must** be used in conjunction with [Box Content Preview](https://developer.box.com/docs/box-content-preview). The latest version of Box Annotations is officially supported in the [Box Web Application](https://app.box.com) only. Older versions may be available for use in third-party applications, but are not officially supported. This library is built and deployed as an [NPM package](https://www.npmjs.com/package/box-annotations).
## Development
- [Dev Setup](docs/DEVELOPING.md)
- [Contributing](docs/CONTRIBUTING.md)
## Support
If you have any questions, please search our [issues list](https://github.com/box/box-annotations/issues) to see if they have been previously answered. Report new issues [here](https://github.com/box/box-annotations/issues/new).
For general Box Platform, API, Elements, and Annotations questions, please visit our [developer forum](https://community.box.com/t5/Developer-Forum/bd-p/DeveloperForum) or contact us via one of our [available support channels](https://community.box.com/t5/Community/ct-p/English).
## Copyright and License
Copyright 2016-present Box, Inc. All Rights Reserved.
Licensed under the Box Software License Agreement v.20170516.
You may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://developer.box.com/docs/box-sdk-license
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.