guestbell / slate-plugins Goto Github PK

Collection of slate plugins

TypeScript 100.00%

slate-plugins's Introduction

Slate plugins

Collection of slate plugins, initially forked from great gitbook repositories.

⚠️ Ever since gitbook abandoned the original version of slate and decided to fork their own, some plugins have been greatly neglected. This is our attempt to bring these plugins up to date with latest versions of slate. Please note that we will accept pr with new plugins, but we won't accept requests for us updating plugins that we don't use in guestbell. Please note we've rewritten plugins in typescript and also made some changes that might cause api to be inconsistent.

Demo

Check out online demo

Getting Started

Plugins are publish via scope @guestbell, therefore to install, you do

yarn add @guestbell/slate-edit-list

Tests

We have temporarily disabled testing on these plugins. In some bright future, we expect to fix them and reenable.

Development

Slate plugins is a monorepo maintained using lerna. All standard lerna rules applies.

yarn start

Created and sponsored by

GuestBell - Customer centric online POS for Hotels and short terms stays.

Contributing

We'll be happy to accept PRs from anybody.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Peter Kottas

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

It goes without saying most of this work is based on amazing work gitbook guys did.

slate-plugins's People

Contributors

Stargazers

Watchers

Forkers

sbezludny atomicman57 space11

slate-plugins's Issues

Undo after an 'unwrapList' change creates invalid state

Hi, thank you so much for the amazing work you've done bringing these plugins up to date.

This issue is related to the 'slate-edit-list' plugin.

I am facing an issue when using the undo feature of slate after triggering an unwrapList action. When my selection is in a list item, I click on my list button, which is set up to trigger the unwrapList change. This works perfectly and unwraps the current list item's content.

However, when I try to undo, it seems to corrupt the editor's state, creating an empty list item at the beginning of my editor's content, and eventually resulting in the following error:

A schema rule could not be normalized after sufficient iterations. This is usually due to a `rule.normalize` or `plugin.normalizeNode` function of a schema being incorrectly written, causing an infinite loop

I don't define any custom normalise rules in my editor schema, so I think this error is caused by the schema defined in this plugin.

I think the problem comes from the way Slate reverses the logic implemented in unwrapList, but I'm not sure what it's doing exactly to be honest!

Have you come across anything like this, and is there an easy fix?

Issue Toggling Bullet Lists when highlighted

Currently, if you highlight an entire list item and click the ul_list icon, the list does not toggle off correctly.

Steps:

Visit https://guestbell.github.io/slate-plugins/slate-edit-list
Create a bulleted list
highlight all or some of the bullets
Click the list icon

Expected Outcome:
Bullets are toggled

Actual Outcome
Bullets are further indented

Also note that if you just click in a list item (instead of highlighting), it works correctly.

I did notice that inList is false here when the whole list is highlighted. Is there another util function to use besides isSelectionInList if the entire list is highlighted? Or should isSelectionInList return true in these cases?