Skip to content

release_10.5.0
Compare
Choose a tag to compare
@tomlyn tomlyn released this 19 Apr 23:01
release_10.5.0
f85ede1
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Feature Enhancements

Common-canvas

  • #612 Improve palette search

    In 10.5.0, the palette search function in common canvas has been completely replaced. Features of the new design are:

    • When the user enters search text in the search field, the palette immediately refreshes on each keystroke to show a result set of nodes matching to the text entered.
    • For each node, the following text is searched: the category label, the node label and the node description
    • If the user enters more than one word (separated by a space) the words entered are searched for independently in the category label, node label and description of each node. This means words can be entered in any order and the same result set is found.
    • Occurrences of search words are highlighted in the category and node labels and the description.
    • The nodes in the result set are ranked in order of importance where the occurrence of multiple words and the occurrence of search words in the node label give greater weight to the ranking. Nodes with the same ranking are displayed in the same order they would appear in the categories of the palette.
    • If the search text is deleted from the search field the palette returns to its traditional category layout display.
    • A debounce architecture is used so the user can rapidly make key presses while typing a search string without overwhelming the system.
    • Descriptions longer than 150 characters are truncated with a Show more button. Long descriptions are truncated so that the first occurrence of any of the search words is displayed. In other words, if the first occurrence if one of the search words is at character 200 the beginning of the description will be truncated so the highlighted word is displayed.
    • When the Show more button has been clicked and the long description displayed, a Show less button will be shown.
    • For performance of display reasons, result sets are restricted to 10 nodes.

Warning: Some of the internal class names for elements of the palette have changed. If you need more details let me (Craig Tomlyn) know.

Palette search in action:

palette search

Examples of truncated node descriptions:

image

Common-properties

  • #622 When heading is enabled, show help button in heading

    In common-properties, the right-side flyout heading is optional. A help icon will be shown if host applications provide a help object in the paramDef or formData.

    When the heading is enabled, a help icon is added in the heading -
    image

    When heading is disabled, help icon is added next to edit title icon -
    image

  • #628 Support "light" option in common-properties

    Common-properties now support a light option that changes the carbon controls being used to light mode.
    The light option is enabled by default.
    To disable the light option, host applications can set <CommonProperties light={false} />

    When the light option is disabled, the background color will be same as the carbon theme background.
    When the light option is enabled, the background color is $ui-01.

    The difference is appearance for the light option disabled (Left side image) and enabled (Right side image) is shown below:

    image image

    The light option can be configured in the test harness

    image

Issues Resolved

#628 Support light option in common-properties (#629)
#630 Palette search string including spaces adds extra characters (#631)
#622 When heading is enabled, show help button in heading (#623)
#625 Remove uneeded npm module from package.json (#626)
#612 Improve palette search (#621)

Assets 2
Loading