https://github.com/untemps/svelte-readotron
Svelte component to display an estimated reading time
https://github.com/untemps/svelte-readotron
component javascript read-o-meter reading-rates reading-time reading-time-estimator speed-reading-time svelte svelte-component
Last synced: 3 months ago
JSON representation
Svelte component to display an estimated reading time
- Host: GitHub
- URL: https://github.com/untemps/svelte-readotron
- Owner: untemps
- License: mit
- Created: 2021-01-05T22:20:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T20:44:35.000Z (over 1 year ago)
- Last Synced: 2025-02-09T10:15:38.759Z (4 months ago)
- Topics: component, javascript, read-o-meter, reading-rates, reading-time, reading-time-estimator, speed-reading-time, svelte, svelte-component
- Language: JavaScript
- Homepage: https://svelte-readotron.vercel.app/
- Size: 1.24 MB
- Stars: 41
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Svelte component to display an estimated reading time
---
[](https://www.npmjs.com/package/@untemps/svelte-readotron)
[](https://github.com/untemps/svelte-readotron/actions)
[](https://codecov.io/gh/untemps/svelte-readotron)
## Demo
:red_circle: LIVE
DEMO :red_circle:
## Installation
```bash
yarn add @untemps/svelte-readotron
```
## Usage
### Basic usage
```html
import Readotron from '@untemps/svelte-readotron'
...
```
`selector` prop is mandatory as it points to which element contains the text content to parse.
You can utilize any selector supported by the Web API [querySelector](https://developer.mozilla.org/fr/docs/Web/API/Document/querySelector) function.
If several elements match the selector, it only parses the text of the first element in the array.
The component will wait for the element to be present in the DOM before parsing its content. If the element is not found after 1000ms, an error is raised and displayed.
This is achieved with the [@untemps/dom-observer](https://github.com/untemps/dom-observer) package.
### Lang
'lang' is an optional prop that designates the language of the text to parse. The component implements the [@untemps/read-per-minute](https://github.com/untemps/read-per-minute) underhand package which returns an estimation based on the _lang_ (language).
Reading rates by _lang_ come from ["How many words do we read per minute? A review and meta-analysis of reading rate"](https://osf.io/4nv9f/) by Marc Brysbaert - Department of Experimental Psychology Ghent University
| Lang | Rate |
| ------- | ---- |
| default | 200 |
| ar | 181 |
| zh | 260 |
| nl | 228 |
| en | 236 |
| fi | 195 |
| fr | 214 |
| de | 260 |
| he | 224 |
| it | 285 |
| ko | 226 |
| es | 278 |
| sv | 218 |
If a lang is not defined or the provided lang is not listed, the **default** value (200) will be applied.
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
...
```
### Template
You can customize the Readotron display by using the `template` prop.
- A template can be a string with one or more tokens delimited with `%`
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
...
```
- A template can be a function with `time` and `words` as arguments.
The function should return a template literal with the markup to display using optionally arguments as placeholders. But it may return any displayable type as well.
> :warning: The string will be parsed with the `{@html}` expression: **Be very careful with the content you pass or allow to pass in to this prop!**
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
` Reading Time: ${time} minutes (${words} words)`}/>
...
```
#### Avalaible tokens/arguments
| Token | Description |
| ------- | ----------------------------------- |
| `time` | Estimated reading time (in minutes) |
| `words` | Number of words |
### Scroll Support
You are able to track and update component values by opting in the `withScroll` flag.
This will change the `time` (remaining time to read) and `words` (number of remaining words) as the user scroll the document.
> Note: There is no support for `element` scrolling so far, `document` only.
The component uses the [scrollProgress](https://github.com/jeremenichelli/scrollProgress) underhand package to track document scrolling.
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
...
```
### Change Event
If you need to be notified whenever values change, you may attach a listener to the `change` event emitted by the component.
---
_Note: The change event will be dispatched only if the `withScroll` prop is set to `true` since this is the only use case that triggers the change event so far_
---
The handler will be triggered for the first time during the mounting phase with the initial values.
#### Handler Signature
Here are the properties available inside the `event.detail` sent with the event:
| Props | Type | Description |
| ---------- | ------ | --------------------------------------------- |
| `time` | number | Estimated remaining reading time (in minutes) |
| `words` | number | Number of remaining words |
| `progress` | number | Ratio of progression (between 0 and 1) |
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
{
const {detail: {time, words, progress}} = event
console.log('Time:', time + ' minutes')
console.log('Words:', words + ' remaining words')
console.log('Progress:', progress * 100 + '%')
}}/>
...
```
#### Recipe
The event dispatching allows to animate a progress bar in sync with the reading status:
```html
import Readotron from '@untemps/svelte-readotron'
let readingProgress = 0
{
readingProgress = event.detail.progress
}}/>
...
.progress-bar {
background-color: #0075ff;
height: 20px;
position: fixed;
left: 0;
bottom: 0;
}
```
### Slot
Another way to customize the display is to use the `` element.
If a `` is passed in as Readotron child and correctly set (see Constraints below), it will be rendered instead of the default layout. This has precedence over the `template` prop.
This allows to set a specific tag as parent if needed.
#### Constraints:
The `` element has to be set with the prop `slot="content"`
#### Avalaible tokens
Like `template`, tokens are passed back to the component to display dynamic values (see [Svelte API documentation](https://svelte.dev/docs#slot_let)):
| Token | Description |
| ------- | ----------------------------------- |
| `time` | Estimated reading time (in minutes) |
| `words` | Number of words |
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
{time} min ({words} words)
...
```
Please see the [Svelte API documentation](https://svelte.dev/docs#slot) to know more about the `` element.
### Styles
All HTML attributes are automatically passed to the parent element of the component (`span`).
That means you can query the `class` attribute to customize the style of the component.
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
...
.readotron {
color: #0075ff;
font-weight: 600;
}
```
If you use a `` element, as it will replace the original layout, you have to switch the class name from the `` element to the `` element.
```html
import Readotron from '@untemps/svelte-readotron'
{time} min
...
```
### Error
If an error occurs during the parsing phase, the component catches and exposes it through an `error` variable which is displayed as is it by default. That means the error message uses the exact same styles as time value.
You may want to customize this error message, so the component provides a `slot`, named `error`, which replaces the default display if passed in.
#### Example
```html
import Readotron from '@untemps/svelte-readotron'
{time} min
Oops!
...
.readotron {
color: #0075ff;
font-weight: 600;
}
.error {
color: #ff0000;
font-weight: 600;
}
```
#### Constraints:
The `` element has to be set with the prop `slot="error"`
#### Avalaible tokens
Error message is passed back to the component for display purpose if needed (see [Svelte API documentation](https://svelte.dev/docs#slot_let)):
| Token | Description |
| ------- | ---------------------- |
| `error` | Original error message |
### API
| Props | Type | Default | Description |
| ------------ | ------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `selector` | string | (required) | Selector of the element which contains the content to parse. See [document.querySelector](https://developer.mozilla.org/fr/docs/Web/API/Document/querySelector) |
| `lang` | string | 'en' | Lang of the content [""ar', 'zh', 'nl', 'en', 'fi', 'fr', 'de', 'he', 'it', 'ko', 'es', 'sv'] |
| `template` | string or function | '%time% min read' | Display template which contains dynamic tokens to be replaced by the parsed values. See [Template](#template) |
| `withScroll` | boolean | false | Enable updates on scroll. If true, `time` and `words` values will reflect the document scroll position |
### Events
| Props | Arguments | Type | Description |
| -------- | ---------- | ------ | ------------------------------------------------------------------------------------------- |
| `change` | | | **Dispatches whenever time and words have changed** |
| | `time` | number | Estimated remaining reading time (in minutes) Estimated remaining reading time (in minutes) |
| | `words` | number | Number of remaining words |
| | `progress` | number | Ratio of progression (between 0 and 1) |
## Development
The component can be served for development purpose on `http://localhost:10001/` running:
```
yarn dev
```
## Contributing
Contributions are warmly welcomed:
- Fork the repository
- Create a feature branch
- Develop the feature AND write the tests (or write the tests AND develop the feature)
- Commit your changes
using [Angular Git Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
- Submit a Pull Request