https://github.com/compactjs/chatscroll
Auto scroll to bottom
https://github.com/compactjs/chatscroll
auto auto-scroll bottom chat javascript scroll
Last synced: 10 months ago
JSON representation
Auto scroll to bottom
- Host: GitHub
- URL: https://github.com/compactjs/chatscroll
- Owner: CompactJS
- License: mit
- Created: 2020-04-12T21:21:49.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T11:52:11.000Z (almost 3 years ago)
- Last Synced: 2025-02-18T09:38:53.033Z (11 months ago)
- Topics: auto, auto-scroll, bottom, chat, javascript, scroll
- Language: HTML
- Homepage: https://compactjs.github.io/chatscroll/
- Size: 1.5 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@compactjs/chatscroll
Auto scroll to bottom
·
Homepage
·
View Demo
·
Report Bug / Request Feature
·
## Table of Contents
- [Installation](#Install)
- [Usage](#usage)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## Install
### NPM:
```sh
npm install @compactjs/chatscroll
```
### CDN:
```html
```
## Usage
### As module:
```javascript
import { observe } from '@compactjs/chatscroll';
```
### Example:
```javascript
const container = document.getElementById('container');
observe(container);
```
Have a look at the [example](https://github.com/CompactJS/chatscroll/blob/main/example/index.html).
Or checkout the [demo](https://compactjs.github.io/chatscroll).
## Run tests
```sh
npm run test
```
## Contact
👤 **Timo Bechtel**
- Website: https://timobechtel.com
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/CompactJS/chatscroll/issues)
1. Fork the Project
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `npm run test`
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the Branch (`git push origin feat/AmazingFeature`)
1. Open a Pull Request
### Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Distributed under the [MIT](https://github.com/CompactJS/chatscroll/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_