Skip to content

feat: add rtl option to keep Persian words intact #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add rtl option to keep Persian words intact #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# [<img src="https://splitting.js.org/splitting.gif" alt="Splitting.js" style="max-width: 100%; height:auto" />](https://splitting.js.org)

### Options

- `rtl` (boolean, default: `false`)
When `true`, **each word** is left intact in a *single* `.char` span—rather than splitting into letters—so that Persian/Arabic ligatures remain connected.

#### Usage

```js
Splitting({
target: ".my-text",
by: "words chars",
whitespace: false,
rtl: true // ← enable full-word spans for RTL scripts
});

### _CSS Vars for split words, chars & more!_

![The current build status based on whether tests are passing](https://api.travis-ci.org/shshaw/Splitting.svg?branch=1.0.0)
Expand Down
Loading