Skip to content

Commit 6d28a84

Browse files
committed
improve comments
1 parent d1d524c commit 6d28a84

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This is a major release, and it might be not compatible with your current usage
5858
- `<Button />`, `<FieldItem />`, `<FieldSet />`, `<MultiSuggestField />`
5959
- removed support for old state properties `hasStatePrimary`, `hasStateSuccess`, `hasStateWarning` and `hasStateDanger`
6060
- `<Notification />`
61-
- removed support for old state properties `neutral`, `sSuccess`, `warning` and `danger`
61+
- removed support for old state properties `neutral`, `success`, `warning` and `danger`
6262
- `<Icon />`
6363
- removed `description` and `iconTitle` properties
6464
- `<OverviewItemList />`

src/components/AutocompleteField/AutoCompleteField.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,12 @@ SuggestField.defaultProps = {
172172
/**
173173
* A component with the appearance of an input field that allows to select and optionally create new items.
174174
* It shows suggestions for the entered text from which the user can select any option.
175+
*
175176
* It has the following fixed behavior:
176177
*
177178
* - When not focused, a different representation of the item value can be shown, e.g. the label of the value.
178179
* - When changing an existing item the input text is set to the original value in order to be able to edit the original value.
179-
* - When for a specific input text, the only item returns is the currently set item itself, all items are shown below it, to make
180+
* - When for a specific input text, the only item returned is the currently set item itself, all items are shown below it, to make
180181
* clear that there are still other items to choose from.
181182
* - The suggestions are fetched with a short delay, so not too many unnecessary requests are fired.
182183
* - Items where itemRenderer returns a string have a default representation, i.e. highlighting of search words, active flag etc.

src/components/Form/FieldItem.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ import { TestableComponent } from "../interfaces";
66
import Label, { LabelProps } from "../Label/Label";
77

88
/*
9-
TODO: Improve development convenience and prevent development errors
9+
TODO: improve development convenience to prevent development inconsistencies
1010
1111
* disabled state could be automatically forwarded to inserted input element,
12-
currently this need to be dome explicitly .
13-
* input id could be forwarded to label and input element
14-
* input id could be created when not given
12+
currently this need to be dome explicitly (currently not implemented)
13+
* input id could be forwarded to label and input element (currently not implemented)
14+
* input id could be created when not given (currently not implemented)
1515
*/
1616

1717
export interface FieldItemProps extends React.HTMLAttributes<HTMLDivElement>, TestableComponent {

0 commit comments

Comments
 (0)