svelte-typewriter

A simple and reusable typewriter effect for your Svelte applications

DEMO

Summary

• Installation
• Usage
  • Component-based approach
  • Directive-based approach
• Props
  • Settings
    • Modes
  • Event listeners
  • Child attributes
  • CSS variables
• Used by
• FAQs
  • UMD and IIFE output formats are not supported for code-splitting builds
  • Test suite failed to run: SyntaxError: Unexpected token '<'
• Contributing

Installation

pnpm i -D svelte-typewriter

pnpm is used here just as an example, you can use your package manager of choice

Usage

Component-based approach

In order to use this method, you need to import the Svelte component, and wrap your elements with the <Typewriter> component

<script>
    import Typewriter from 'svelte-typewriter'
</script>

<Typewriter>
    <h1>Testing the typewriter effect</h1>
</Typewriter>

Directive-based approach

This method relies on Svelte actions (more specifically, the use:action directive), in order to animate your components with this approach, you must import the directive of the animation mode you want to use and include it as a attribute on your element

<script>
    import { concurrent } from 'svelte-typewriter'
</script>

<p use:concurrent={{ interval: 30 }}>Testing the typewriter effect</p>

Each mode has it's own directive, which accepts a single object parameter that can be used to set the animation props (just like on the component-based approach)

There are just a few limitations of this approach to keep in mind:

• For now, there's no way to have the cursor caret on the text being animated
• Event listeners (like on:done) won't be triggered
• Depending on the animation mode you're using, some essential animation properties must be explicitly specified, because they don't have default values when used on a directive, otherwise the animation won't work properly, those include interval, wordInterval, writeInterval and scrambleDuration

Props

The <Typewriter> component can receive props that allows to manipulate the behavior of the resulting animation, these props are divided into the following groups

• Settings: general animation properties
• Event listeners: functions executed based on the condition of a trigger
• Child attributes: child elements animation properties
• CSS variables: styling-related properties

Settings

Modes

You can control the behavior of the typewriter effect by passing specific props to the <Typewriter> component, the table below contains information about all modes:

Event listeners

Child attributes

CSS variables

Used by

FAQs

UMD and IIFE output formats are not supported for code-splitting builds.

From version 2.1.17 onwards, this library makes use of dynamic imports, if your Rollup configuration output.format is set to iife or umd, consider setting inlineDynamicImports to true, otherwise, change output.format to something else, like esm (for more details, consider checking #21)

Test suite failed to run: SyntaxError: Unexpected token '<'

This happens because Jest cannot parse Svelte syntax right away, it needs to be transformed by svelte-jester first, therefore, we must tell Jest to NOT ignore svelte-typewriter, as by default, everything inside node_modules is ignored and parsed as-is without any kind of pre-processing, this can be done by setting the transformIgnorePatterns property on your Jest configuration, example below:

// jest.config.js
module.exports = {
    transformIgnorePatterns: ["/node_modules/(?!(svelte-typewriter)/)"]
}

More details on #73

Contributing

1. Fork it
2. Create your feature branch: git checkout -b fix/my-new-bug-fix
3. Preview your changes by running the dev script on package.json
4. Commit your changes: git commit -am 'fix: solve some issue'
5. Push to the branch: git push --set-upstream origin fix/my-new-bug-fix
6. Submit a pull request