New: Add option for disabled button text (fixes #207)

[swashbuck]

Fix #207

New

• Adds the ability to show different text when the button is disabled. The new properties are disabledText and disabledAriaLabel.

Testing

1. Set up Trickle using the code from example.json
2. _styleBeforeCompletion should be set to visible so that you can see the button before it is enabled
3. Test different scenarios including:

• text is set but disabledText is not set.
• text and disabledText are set as well as startText and finalText

The order of precedence that text will be shown is:

disabledText
startText
finalText
text

For instance, if the Trickle is on the final block and disabledText is set, that will be used. Otherwise, it will check for finalText when the button is disabled. Finally, it will fall back to text.

[joe-allen-89]

It's working as described, it feels a bit strange that throughout the page trickle says it's locked but on the last block it doesn't if finalText is set despite it being locked, might be confusing to users.

[swashbuck]

It's working as described, it feels a bit strange that throughout the page trickle says it's locked but on the last block it doesn't if finalText is set despite it being locked, might be confusing to users.

@joe-allen-89 Maybe we should add locked text for final and start as well? We never use those options in projects, as far as I know.

[oliverfoster]

I'd prefer you called it disabledText and disabledAriaLabel. As locking is a model state and disabled is a button state. The convention is to put the descriptor first - playText, stopText, itemText, resumeButtonText, promptText, buttonText, startText, finalText, backLabel, nextLabel etc.

[oliverfoster]

It's working as described, it feels a bit strange that throughout the page trickle says it's locked but on the last block it doesn't if finalText is set despite it being locked, might be confusing to users.

@joe-allen-89 Maybe we should add locked text for final and start as well? We never use those options in projects, as far as I know.

Maybe it should just take precedence over startText and finalText?

disabledText
finalText
startText
text

[swashbuck]

@joe-allen-89 @oliverfoster Changes made and PR description updated

[joe-allen-89]

👍

[cahirodoherty-learningpool]

👀

[github-actions]

🎉 This PR is included in version 7.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀