Skip to content
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.

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

Word count plugin #2571

Closed
msamsel opened this issue Jun 5, 2019 · 2 comments · Fixed by ckeditor/ckeditor5-word-count#2
Closed

Word count plugin #2571

msamsel opened this issue Jun 5, 2019 · 2 comments · Fixed by ckeditor/ckeditor5-word-count#2
Assignees
Labels
package:word-count type:feature This issue reports a feature request (an idea for a new functionality or a missing option).
Milestone

Comments

@msamsel
Copy link
Contributor

msamsel commented Jun 5, 2019

MVP

The plugin should provide information about the number of characters and words in the editor.

  1. Expose a word counter container with automatically updated content. Display it as Characters: NNN

    Example:

    .create( container, {
      wordCount: {
        container: myContainer
      }
    } )
    .then( editor => {
      myContainer.appendChild( editor.plugins.get( 'WordCount' ).wordCountContainer )
    } )
  2. Support counting words and characters. Display it as Words: NNN. Characters: NNN. Provide configuration option to disable/enable given field:

    • config.wordCount.displayCharacters
    • config.wordCount.displayWords
  3. Allow on output customization. There should be a render function which allows on an update of any element you want config.wordCount.onUpdate( stats )

Next steps

  1. Support limits for words and/or characters config.wordCount.wordLimit/characterLimit (package.json should be indented with tabs #7):
    • Indicate the limit by changing the style of the WordCounter container
    • display limit as: Characters: NNN/MMM
  2. Highlight the words/characters above the limit in the editor (similar to Twitter) (A builder's option to create non-AMD and AMD-without-polluting packages #8).
  3. Display progressbar (Introduce promises lib #9).
  4. Improve internationalization (Plugins path resolution #4).
Reinmar referenced this issue in ckeditor/ckeditor5-word-count Jul 1, 2019
Feature: Introduce word count feature. Closes #1. Closes ckeditor/ckeditor5#1301.
@Reinmar
Copy link
Member

Reinmar commented Jul 1, 2019

Can you move the things from "next steps" to new tickets?

@msamsel
Copy link
Contributor Author

msamsel commented Jul 1, 2019

Can you move the things from "next steps" to new tickets?

I create tasks for it and make reference to them in this issue description.

@mlewand mlewand transferred this issue from ckeditor/ckeditor5-word-count Oct 9, 2019
@mlewand mlewand added this to the iteration 25 milestone Oct 9, 2019
@mlewand mlewand added status:confirmed type:feature This issue reports a feature request (an idea for a new functionality or a missing option). package:word-count labels Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:word-count type:feature This issue reports a feature request (an idea for a new functionality or a missing option).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants