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

v5.0.0 #684

Merged
merged 26 commits into from
Aug 20, 2020
Merged

v5.0.0 #684

merged 26 commits into from
Aug 20, 2020

Conversation

linuswillner
Copy link
Owner

@linuswillner linuswillner commented Aug 19, 2020

This version brings with it several new major features to react-console-emulator.

Breaking changes

The recommended method for terminal input text styling has been moved. Terminal input text should now be styled using the inputTextStyle and inputTextClassName props. Note: If using the newly-introduced styling persistence options for command echoes, leaving text styling in inputStyle or inputClassName may cause unexpected styling bugs.

The styleEchoBack prop no longer accepts boolean input. Instead, one should either omit it (For default behaviour) or define one of the string types detailed in the options.

Main changes

Async command executor support is here! You can now use async functions as command handlers and their outputs will function identically to synchronous functions.

Added the ability to hide the prompt area entirely when the terminal is disabled either manually through the disabled prop or on process if disableOnProcess is enabled (#639).

Added the ability to set the terminal to read-only mode with the readOnly prop, which disables input entirely and hides the prompt area (#639).

Other changes

Fixed a bug where newline parsing did not recognise newline literals properly (#632).

Full run-down of prop changes:

+ inputTextStyle
+ inputTextClassName
+ hidePromptWhenDisabled
+ readOnly

Closes #632
Closes #638
Closes #639
Closes #640

@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2020

Codecov Report

Merging #684 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #684   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         5    +1     
  Lines           58        67    +9     
  Branches        16        19    +3     
=========================================
+ Hits            58        67    +9     
Impacted Files Coverage Δ
src/Terminal.jsx 100.00% <100.00%> (ø)
src/handlers/parseEOL.js 100.00% <100.00%> (ø)
src/utils/shouldPromptBeVisible.js 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 57d615d...19d915c. Read the comment docs.

@linuswillner linuswillner marked this pull request as ready for review August 20, 2020 13:27
@linuswillner linuswillner merged commit 04b5f49 into master Aug 20, 2020
@linuswillner linuswillner deleted the develop branch August 20, 2020 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants