-
Notifications
You must be signed in to change notification settings - Fork 278
Description
Features
Integration of popover API in all pop-up based components
- done
Form Support with Form-Associated Custom Elements standard
- done
Timezone support
- done
New Components
- Dynamic Page - high prio
- Form - high prio and will be experimental
- Text
- Tool Layout (after initial 2.0 release)
- Tokenizer - high prio and will be experimental
- AI Prompt Input
- AI Button
Components Features
- List Drag and Drop - high prio (change)
- Tree Drag and Drop
- TabContainer Drag and Drop
- Link with Icon
- New Notifications Experience - high prio
- physical Select Option (leveraging popover API) - high prio
- physical Menu Item (leveraging popover api) - high prio
- physical Input suggestion (leveraging popover api) - high prio
- Color Palette: Item Selection
- Menu Item: endContent slot
Reusable component styles for creating patterns/layouts
- Input Icon - high prio
New Site for Documentation, Samples and API reference - Done
- Live editor, Playground, Dark mode, Icons view
Breaking Changes
@ui5/webcomponents & @ui5/webcomponents-fiori
- Rename
after-opentoopenandafter-closetoclose
Replace all public methods for opening popover, such as openPicker, togglePicker with open property to promote declarative APIs:
- DatePicker#openPicker to be replaced by
openproperty. change - DateTimePicker#openPicker to be replaced by
openproperty. change - Input#openPicker to be replaced by
openproperty. change - Toast#show to be replaced by
openproperty. change) -
Dialog.showmethod to be replaced withDialog#openproperty - ViewSettingsDialog#show to be replaced by
openproperty. change
@ui5/webcomponents
Wrapping by default (wrappingType="Normal" by default, wrappingType="None" optionally)
- RadioButton
- CheckBox
- Label
- NotificationListItem
- Tag
- Link
- Тext
- Title
List, StandardListItem
- Remove property
imagein favour of slotimage- !should be discussed once more! (depends on suggestion item refactoring) - Rename slot
imageContenttoimage
StandardListItem
- Rename CustomListItem to ListItemStandard (change)
CustomListItem
- Rename class CustomListItem to ListItemCustom (change)
Badge (ui5-badge rename to ui5-tag)
- Rename component and tag name.
Badge (ui5-badge)to to becomeTag (ui5-tag)-as Tag term is established on SAP Design specs, and to avoid confusion with theBadgingconcept. - high prio (change) - Change default values of
designproperty - fromSet3toNeutral(change) - Remove design "Set3"
Breadcrumbs (ui5-breadcrumbs)
- Rename property
separator-styletoseparators(aligned with List#separators property) (change)
BusyIndicator (ui5-busy-indicator)
- Rename BusyIndicatorSize options from "Small", "Medium" and "Large" to "S", "M" and L (change)
Card (ui5-card)
- Remove the
ICardHeaderinterface and replace it with theCardHeadercomponent in theCard#headerslot type. refactor(ui5-card): remove ICardHeader interface #8497 - Rename property
statustoadditionalText(change)
CardHeader (ui5-card-header)
- Rename
statustoadditionalText(change)
Carousel (ui5-carousel)
- Replace existing items-per-page-s, items-per-page-m, items-per-page-l properties with single
items-per-page="S1 M1 L1" - Rename property
page-indicator-styletopage-indicator-type(change)
Calendar (ui5-calendar)
- Rename
selected-dates-changeevent toselection-change - Rename
selected-dates-changeevent detailsvaluesanddatestoselectedValuesandselectedDateValues. - [enhancement] Add new element
CalendarDateRange(with properties startValue and endValue) that could be passed to form a range in declarative manner
ColorPicker (ui5-color-picker)
- Rename property
colortovalue- more consistent with the rest of the pickers.
ColorPalletePopover (ui5-color-palette-popover)
- Remove
openPopoverandshowAtmethods in favour ofopenandopener(change)
Combo Box (ui5-combo-box)
-
Grouping- Instead of usingComboBoxGroupItemas separator in a flat structure, the API will expect nesting of ComboBoxItems inside ComboBoxGroupItem however we would like to be implemented first in the List and be used later by ComboBox, MultiComboBox, Input with Suggestions. - Event
changewon't be fired on arrow up/down any more (onlyselection-changewould be fired)
Input (ui5-input)
- Replace
suggestion-item-previewandsuggestion-item-selectin favour ofselection-change(change)
Label (ui5-label)
- Change default of
wrapping-typetoNormal, e.g the Label will wrap be default, and will only truncate if explicitly setwrapping-type="None". (change)
List (ui5-list)
- Rename
HighlightTypestoHighlightTypeorHighlightas more consistent (comment) - Rename
modetoselectionModeas more descriptive (change) - Rename
busytoloading(change) - Rename
ListModeenumeration toListSelectionMode(change) - Rename selection modes values:
SingleSelectBegintoSingleStart,SingleSelecttoSingle,MultiSelecttoMultiple,SingleSelectEndtoSingleEnd,SingleSelectAutotoSingleAuto(change) - ❗ Replace
ListGroupHeaderItemitem withListGroupItemcomponent to implement trueGrouping. Instead of a flat structure, the API will support nesting of Items inside ListGroupItem to form a group of items. (change)
Menu (ui5-menu)
- Remove
starts-sectionproperty - to be replaced by new componentui5-menu-separator(similar toui5-toolbar-separatorandui5-tab-separator) (change)
Multi Combo Box
- Rename property
allowCustomValuestonoValidation(change)
Popup
- Remove
isOpenmethod in favour ofopenproperty
Dialog (ui5-dialog)
- Remove
showandclosemethods in favour ofopenproperty. Parameter preventInitialFocusshowmethod is added as a property.
Popover (ui5-popover)
- Rename enum values of
PopoverPlacementType#LefttoPopoverPlacementType#StartandPopoverPlacementType#RighttoPopoverPlacementType#End(change) - Rename enum values of
PopoverHorizontalAlign#LefttoPopoverHorizontalAlign#StartandPopoverHorizontalAlign#Leftto `PopoverHorizontalAlign#End. (change) - Rename property
placementTypetoplacement(change) - Remove
#hide-backdropproperty as the backdrop can be styled with standard CSS::backdropselector. - Remove
#modalproperty as not relevant to the Popover. SAP Design confirmed that these props don't belong to the Popover. - We'll keep this property. - Remove
showAtmethods in favour ofopenandopener. ParameterpreventInitialFocusfromshowAtmethod is added as a property.
Progress Indicator (ui5-progress-indicator)
- Remove
disabledproperty - Progress indicator isn't an interactive element so disabled property make no sense. Also aria-disabled is deprecated on the progress bar role since ARIA 1.2 . (change)
SegmentedButton (ui5-segmented-button)
- Rename the
modeproperty toselectionMode - Remove the
selectedItemgetter - will be replaced by theselectedItems(as more than one items can be selected - Remove the
selectedItemevent parameter - will be replaced byselectedItemsevent parameter - Rename selection modes values:
SingleSelecttoSingleandMultiSelecttoMultiple - Rename enumeration
SegmentedButtonModetoSegmentedButtonSelectionMode
SegmentedButtonItem
- Rename property
pressedtoselected- more consistent with theselectedItemsgetter , theselectedItemsevent detail and theselection-changeevent
Select (ui5-select)
- Remove
menuproperty (if SelectMenu, SelectMenuOption are being removed)
Selects's Option (ui5-option)
- Remove
disabledproperty - UX and ACC standards suggest to not include any disabled items in the dropdown (change)
SelectMenu, SelectMenuOption (ui5-select-menu, ui5-select-menu-option) - high prio
- Remove the components - the components have been developed to allow adding custom options, but with the popover API, the standard options will allow custom content and the component becomes obsolete
SuggestionItem (ui5-suggestion-item)
The following properties are not specified in the design guidelines. Still, with the integrating the "popover API" in the framework, drop downs can work with physical items, allowing custom suggestion items.
- Remove property
type - Remove property
description - Remove property
icon - Remove property
iconEnd - Remove property
image - Remove property
additionalTextState
Title (ui5-title)
- Change default of
wrapping-typetoNormal, e.g the Title will wrap be default, and will only truncate if explicitly setwrapping-type="None". (change)
Tab (ui5-tab)
- Rename slot
subTabstoItems(change)
TabContainer (ui5-tabcontainer)
- Remove
fixedproperty - it should be always fixed=true by design. No design/accessibility spec available. The ui5-panel has a collapse/expand button, the TabContainer - not. (change) - Remove
TabContainerBackgroundDesignenumeration useBackgroundDesignas type for thebackgroundDesignproperty - only the type changes, available values remain the same (Solid, Transparent and Translucent) (change) - Remove
show-overflowproperty - there are other means to determine the overflow button presence - using theoverflowButtonslot. (change) - Rename
tab-overflow-modetooverflow-mode(change) - Refactor
ITabinterface as described in the comment. (change) - Rename public method
getTabInStripDomRef(name tbd -getItemInStripDomReforgetElementInStripDomRef) (change)
Table (ui5-table)
- Move Table to another package @ui5/webcompoments-compat (change)
TextArea (ui5-textarea)
- Rename growing-max-lines to growing-max-rows
Token (ui5-token)
- Remove the
readonlyproperty - After discussions with the Central Design Team, it was decided that the best approach, when implementing the public Tokenizer component, is to move the logic for the readonly state handling in the Tokenizer itself.
@ui5/webcomponents-fiori
Bar (ui5-bar)
- Move Bar from
@ui5/webcomponents-fiorito@ui5/webcomponents` package - as it is widely used by other components there (mainly popovers, dialogs, etc., as header/sub-header)
BarcodeScannerDialog
- Remove the deprecated
showmethod, in favour of theopenproperty.
IllustratedMessage (ui5-illustrated-message)
- Rename
sizetodesign- the semantic values “Auto”, “Base”, “Spot”, “Dialog”, “Scene”, andsizeaspect of this property is not directly clear. (change) - Remove
titleLevelproperty - users can set the required title level on thetitleslot. (change)
NotificationListGroupItem (ui5-notification-action)
- Remove
showCounterproperty (same can be achieved by adding numbers to thetitleproperty) - Remove
showCloseproperty (latest designs suggest always having a close button)
Page (ui5-page)
- Rename property
disableScrollingtonoScrolling - Remove
floatingFooterproperty and addfixedFooterinstead to flip the default behaviour.? - Change
Page#defaultslot type fromHTMLElementtoNode
Shellbar (ui5-shellbar)
-
Renaming of
copilot,copilotDomRefandshowCoPilotproperties. Or, removing in favour of new slot. -
Remove
CoPilot Animationfeature and the module
import @ui5/webcomponents-fiori/dist/features/CoPilotAnimation.js`SplitButton (ui5-split-button)
- Remove
active-iconproperty. The property allows to swap out the icon while pressed. However, this feature is not available on any other button.
UploadCollection (ui5-upload-collection )
- Rename
modetoselectionMode(change) - Remove the
IUploadCollectionIteminterface and replace it with theUploadCollectionItemclass in theUploadCollection#itemsslot type. (change) - Remove
Deletefrom themodeoptions as there ishide-delete-btnproperty available in the UploadCollectionItem to control the presence of the delete button. (change)
Wizard
- Rename the event detail
changeWithClickof thestep-changeevent (name not decided -scrolled: true|falseorwithScroll: true | false)
A11y Changes
Private title property becomes public tooltip
- check if still needed, if yes - make it public and rename it to tooltip and add documentation when it should be used (for example: icon only button)
- all components with existing tooltip property should add documentation for usage
Components with title property:
Components with tooltip property:
- ListItem - check if still needed. Consider making the wrapping public, instead of exposing a tooltip
- Button/ToolbarButton
- RatingIndicator
2. accessibilityAttributes
accessibilityAttributes becomes the unified (and only) way to expose role related aria-* attributes to the consumers. Only attributes which will not be part of accessibilityAttributes are the following: accessibleRole, accessibleName, accessibleNameRef, landmarkInfo and tooltip.
Components:
- ListItem - aria-haspopup should be part of accessibilityAttributes
- Avatar/AvatarGroup - aria-haspopup should be part of accessibilityAttributes
- Link
- Button/ToolbarButton
- ShellBar
(Change)
4. Other changes:
- Icon: remove
ariaHidden,interactiveandaccessibleRoleand introducemodeproperty with the following optionsIconMode.Image(by default as currently implemented, internally renders role="img"),IconMode.Decorative(internally renders role="presentation" and aria-hidden="true"),IconMode.Interactive(role="button", focus and press handling) - ListItem - remove role property (Change)
- all components using
accessibleRoleshould change the type to enum, not string. For example check the ui5-panel. Affected components: Link, List, ListItem (Change) - Tree/List/ListItem - remove aria-roledescription property as it is not used. - (Change)
5. Update Accessibility documentation after all changes are merged. (Before release)
In Discussion
Toolbar, ToolbarItem (ui5-toolbar, ui5-toolbar-item) ❗ - (after 2.0 initial release)
- Toolbar Popover API Redesign - The introduction of the popover API can replace abstract items concept for the Toolbar popover. This will enable a more flexible and dynamic approach to managing toolbar items.
- ToolbarItem Class Structure: We are considering the replacement of the base class for ToolbarItem with an interface. This should be done if the popover API is implemented. Physical items can implement the new interface and fit toolbar API as supported components.
TODO [Team Pirin]. New design is evaluated that can affect the API decision, so deeper research needed - explore the design, follow up with SAP Design if needed to learn more.
Cross components
Renaming the ValueState and HighlightType enums values and refactoring of all components with valueState, highlight and additionalTextState properties.
- Rename ValueState enum values
Warning -> Critical, Error -> Negative, Success -> Positive - Rename HighlightType enum values
Warning -> Critical, Error -> Negative, Success -> Positive -
MessageStrip#designWarning is changed toMessageStrip#designCritical -
Dialog.statesupported values are changed -
ListItem.highlightsupported values are changed -
TreeItem.additionalTextStatesupported values are changed -
SuggestionItem.additionalTextStatesupported values are changed -
StandardListItem.additionalTextStatesupported values are changed
(change)
@ui5/webcomponents-base
- Remove CSP Support as adopted stylesheets are now supported everywhere. The following module will be removed (change)
import { setUseLinks, setPackageCSSRoot } from "@ui5/webcomponents-base/dist/CSP.js";-
Remove
UI5Element#static get rendermethod replaced byrenderer(change) -
[x]Remove
UI5Element#getStaticAreaItemDomRefmethod as obsolete (no more static area) -
Remove the
Device#isIE()method (change) -
Remove Static Area and Static Area items - after integrating the Popover API, static area won't be required any more.
-
Remove fallback to default value and runtime validation [After ui5con, but for 2.0]
-
Remove
processChildren
@ui5/webcomponents-tools
- Remove the
JSDoc plugin- custom elements (change) - Upgrade to new major
wdioversion would breaking for consumers of wdio.config.js - check if needed as there is research to use Cypress in future
@ui5/webcomponents-theming
- Remove
Belizetheme - theme has been deprecated and wont be supported with 2.0 onward.
@ui5/webcomponents-icons
- Remove
soccor, keepsoccer. (change)
@ui5/webcomponents-icons-business-suite
- Remove
add-polygone, keepadd-polygon(change)
All packages
- Remove Assets-static.js module - use the dynamic Assets.js instead. (change)
Metadata
Metadata
Assignees
Labels
Type
Projects
Status