Editor: Add word count #300
Conversation
nylen
added
[Status] Needs Review
|
This is testing well for me in Chrome 46/OS X 10.11 |
| export default React.createClass( { | ||
| displayName: 'EditorWordCount', | ||
|
|
||
| mixins: [ React.addons.PureRenderMixin ], |
There was a problem hiding this comment.
Since this component has no props, I don't think this is needed.
There was a problem hiding this comment.
But I suppose it does make the component pure/render once, nm.
|
Played around with the branch and confirmed all of our discussion we had in slack around the new event being emitted. LGTM - so pending your css changes I think this is good to go. |
| if ( content && typeof content === 'string' ) { | ||
| content = content.replace( /\.\.\./g, ' ' ); // convert ellipses to spaces | ||
| content = content.replace( /<.[^<>]*?>/g, ' ' ); // remove HTML tags | ||
| content = content.replace( / | /gi, ' ' ); // remove space chars |
There was a problem hiding this comment.
I'm not sure if make sense add spaces here especially if they aren't added in the below lines.
There was a problem hiding this comment.
I wasn't quite sure what to do with that section. I suppose fa276d0 is fine too. Our coding guidelines seem to encourage things like this, though:
Use spaces liberally throughout your code. “When in doubt, space it out.”
and
Spaces may align code within documentation blocks or within a line
|
After some discussion with @kellychoffman we decided to go with a non-fixed option for now. Exploring a sidebar location or a fixed version is something worth trying in the next iteration of it.
|
|
Hey, you fixed the weird padding thing too. Awesome, thanks for the CSS help 👍 |
|
👍 Looks good. Thanks again @MichaelArestad. |
kellychoffman
added
[Status] Ready to Merge
and removed
[Status] Needs Design Review
This PR seeks to add a word count feature to the editor:
props @kellychoffman for the design. Closes #299.
Implementation notes
Right now the
PostEditStoreonly sends achangeevent if thedirtyorhasContentproperties changed. So if the post is dirty, then further typing will not trigger changes. Word count should be closer to real-time though, hence the newrawContentChangeevent.Test instructions
Verify that the word count appears correctly for new and existing posts and pages, and that it updates within 200ms after you stop typing (due to
PostEditor#debouncedSaveRawContent).Verify that the word count appears and updates correctly in both Visual and HTML modes.
Verify that the word count does not appear when the UI is in one of the following languages: Chinese (all variants), Japanese, Korean, Thai.
Still left to do
For future follow-up
Chinese, Japanese, and Thai are character-based so they don't have a notion of word count. Here it would be more appropriate to count characters instead.
WP core has a different word count algorithm, including code to count characters. We should probably use this algorithm instead, because it will allow us to count characters, and Korean is at least one language where the TinyMCE algorithm won't work because its Unicode range is outside of what we're checking for.
Currently we hide the word count widget for these languages. Let's get the initial version out without CJK support and then circle back around to add this later.