Skip to content

Commit ddb0051

Browse files
CardView rename Toolbar / ToolbarItem to resolve ambiguous export name conflicts (#30218)
1 parent 2c0a23f commit ddb0051

File tree

7 files changed

+53
-34
lines changed

7 files changed

+53
-34
lines changed

packages/devextreme-angular/src/ui/card-view/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import {
2424
export { ExplicitTypes } from 'devextreme/ui/card_view';
2525

2626
import DataSource from 'devextreme/data/data_source';
27-
import { CardCover, CardHeader, ColumnProperties, dxCardViewEditing, HeaderPanel, CardClickEvent, CardDblClickEvent, CardHoverChangedEvent, CardInsertedEvent, CardInsertingEvent, CardPreparedEvent, CardRemovedEvent, CardRemovingEvent, CardSavedEvent, CardSavingEvent, CardUpdatedEvent, CardUpdatingEvent, ContextMenuPreparingEvent, EditCanceledEvent, EditCancelingEvent, EditingStartEvent, FieldCaptionClickEvent, FieldCaptionDblClickEvent, FieldCaptionPreparedEvent, FieldValueClickEvent, FieldValueDblClickEvent, FieldValuePreparedEvent, FocusedCardChanged, InitNewCardEvent, SelectionChangedEvent, Paging, RemoteOperations, SelectionConfiguration, Toolbar } from 'devextreme/ui/card_view';
27+
import { CardCover, CardHeader, ColumnProperties, dxCardViewEditing, HeaderPanel, CardClickEvent, CardDblClickEvent, CardHoverChangedEvent, CardInsertedEvent, CardInsertingEvent, CardPreparedEvent, CardRemovedEvent, CardRemovingEvent, CardSavedEvent, CardSavingEvent, CardUpdatedEvent, CardUpdatingEvent, ContextMenuPreparingEvent, EditCanceledEvent, EditCancelingEvent, EditingStartEvent, FieldCaptionClickEvent, FieldCaptionDblClickEvent, FieldCaptionPreparedEvent, FieldValueClickEvent, FieldValueDblClickEvent, FieldValuePreparedEvent, FocusedCardChanged, InitNewCardEvent, SelectionChangedEvent, Paging, RemoteOperations, SelectionConfiguration, dxCardViewToolbar } from 'devextreme/ui/card_view';
2828
import { Mode, ScrollbarMode } from 'devextreme/common';
2929
import { ColumnChooser, FilterPanel, HeaderFilter, Pager, SearchPanel, Sorting } from 'devextreme/common/grids';
3030
import { DataSourceOptions } from 'devextreme/data/data_source';
@@ -576,10 +576,10 @@ export class DxCardViewComponent<TCardData = any, TKey = any> extends DxComponen
576576

577577

578578
@Input()
579-
get toolbar(): Toolbar {
579+
get toolbar(): dxCardViewToolbar {
580580
return this._getOption('toolbar');
581581
}
582-
set toolbar(value: Toolbar) {
582+
set toolbar(value: dxCardViewToolbar) {
583583
this._setOption('toolbar', value);
584584
}
585585

@@ -1159,7 +1159,7 @@ export class DxCardViewComponent<TCardData = any, TKey = any> extends DxComponen
11591159
* This member supports the internal infrastructure and is not intended to be used directly from your code.
11601160
11611161
*/
1162-
@Output() toolbarChange: EventEmitter<Toolbar>;
1162+
@Output() toolbarChange: EventEmitter<dxCardViewToolbar>;
11631163

11641164
/**
11651165

packages/devextreme-angular/src/ui/card-view/nested/toolbar.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818

1919

2020

21-
import { PredefinedToolbarItem, ToolbarItem } from 'devextreme/ui/card_view';
21+
import { dxCardViewToolbarItem, PredefinedToolbarItem } from 'devextreme/ui/card_view';
2222

2323
import {
2424
DxIntegrationModule,
@@ -47,10 +47,10 @@ export class DxoCardViewToolbarComponent extends NestedOption implements OnDestr
4747
}
4848

4949
@Input()
50-
get items(): Array<PredefinedToolbarItem | ToolbarItem> {
50+
get items(): Array<dxCardViewToolbarItem | PredefinedToolbarItem> {
5151
return this._getOption('items');
5252
}
53-
set items(value: Array<PredefinedToolbarItem | ToolbarItem>) {
53+
set items(value: Array<dxCardViewToolbarItem | PredefinedToolbarItem>) {
5454
this._setOption('items', value);
5555
}
5656

packages/devextreme-react/src/card-view.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import dxCardView, {
99
import { Component as BaseComponent, IHtmlOptions, ComponentRef, NestedComponentMeta } from "./core/component";
1010
import NestedOption from "./core/nested-option";
1111

12-
import type { CardClickEvent, CardDblClickEvent, CardInsertedEvent, CardInsertingEvent, CardPreparedEvent, CardRemovedEvent, CardRemovingEvent, CardSavedEvent, CardSavingEvent, CardUpdatedEvent, CardUpdatingEvent, ContextMenuPreparingEvent, EditCanceledEvent, EditCancelingEvent, EditingStartEvent, FieldCaptionClickEvent, FieldCaptionDblClickEvent, FieldCaptionPreparedEvent, FieldValueClickEvent, FieldValueDblClickEvent, FieldValuePreparedEvent, InitNewCardEvent, CardTemplateData, CardHeaderItem as CardViewCardHeaderItem, CardHeaderPredefinedItem, FieldTemplateData, ColumnTemplateData, EditingTexts as CardViewEditingTexts, PredefinedToolbarItem, ToolbarItem as CardViewToolbarItem } from "devextreme/ui/card_view";
12+
import type { CardClickEvent, CardDblClickEvent, CardInsertedEvent, CardInsertingEvent, CardPreparedEvent, CardRemovedEvent, CardRemovingEvent, CardSavedEvent, CardSavingEvent, CardUpdatedEvent, CardUpdatingEvent, ContextMenuPreparingEvent, EditCanceledEvent, EditCancelingEvent, EditingStartEvent, FieldCaptionClickEvent, FieldCaptionDblClickEvent, FieldCaptionPreparedEvent, FieldValueClickEvent, FieldValueDblClickEvent, FieldValuePreparedEvent, InitNewCardEvent, CardTemplateData, CardHeaderItem as CardViewCardHeaderItem, CardHeaderPredefinedItem, FieldTemplateData, ColumnTemplateData, EditingTexts as CardViewEditingTexts, PredefinedToolbarItem, dxCardViewToolbarItem } from "devextreme/ui/card_view";
1313
import type { AnimationConfig, CollisionResolution, PositionConfig, AnimationState, AnimationType, CollisionResolutionCombination } from "devextreme/common/core/animation";
1414
import type { ValidationRuleType, HorizontalAlignment, VerticalAlignment, ButtonStyle, template, ButtonType, ToolbarItemLocation, ToolbarItemComponent, SearchMode, SingleMultipleOrNone, SelectAllMode, DataType, Format as CommonFormat, SortOrder, ComparisonOperator, DragHighlight, Mode, Direction, PositionAlignment, DisplayMode, ScrollbarMode, TabsIconPosition, TabsStyle, Position as CommonPosition } from "devextreme/common";
1515
import type { dxButtonOptions, ClickEvent, ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent } from "devextreme/ui/button";
@@ -2682,7 +2682,7 @@ const To = Object.assign<typeof _componentTo, NestedComponentMeta>(_componentTo,
26822682
// CardView
26832683
type IToolbarProps = React.PropsWithChildren<{
26842684
disabled?: boolean;
2685-
items?: Array<PredefinedToolbarItem | CardViewToolbarItem>;
2685+
items?: Array<dxCardViewToolbarItem | PredefinedToolbarItem>;
26862686
multiline?: boolean;
26872687
visible?: boolean | undefined;
26882688
}>

packages/devextreme-vue/src/card-view.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ import {
3939
Paging,
4040
RemoteOperations,
4141
SelectionConfiguration,
42-
Toolbar,
42+
dxCardViewToolbar,
4343
CardHeaderItem,
4444
CardHeaderPredefinedItem,
4545
EditingTexts,
4646
PredefinedToolbarItem,
47-
ToolbarItem,
47+
dxCardViewToolbarItem,
4848
} from "devextreme/ui/card_view";
4949
import {
5050
Mode,
@@ -357,7 +357,7 @@ const componentConfig = {
357357
selection: Object as PropType<SelectionConfiguration | Record<string, any>>,
358358
sorting: Object as PropType<Sorting | Record<string, any>>,
359359
tabIndex: Number,
360-
toolbar: Object as PropType<Toolbar | Record<string, any>>,
360+
toolbar: Object as PropType<dxCardViewToolbar | Record<string, any>>,
361361
visible: Boolean,
362362
width: [Number, String],
363363
wordWrapEnabled: Boolean
@@ -3112,7 +3112,7 @@ const DxToolbarConfig = {
31123112
},
31133113
props: {
31143114
disabled: Boolean,
3115-
items: Array as PropType<Array<PredefinedToolbarItem | ToolbarItem>>,
3115+
items: Array as PropType<Array<dxCardViewToolbarItem | PredefinedToolbarItem>>,
31163116
multiline: Boolean,
31173117
visible: Boolean
31183118
}

packages/devextreme/js/ui/card_view.d.ts

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,50 +86,63 @@ export type RemoteOperations = {
8686
export type PredefinedToolbarItem = 'columnChooserButton' | 'searchPanel' | 'addCardButton' | 'selectAllButton' | 'clearSelectionButton';
8787

8888
/**
89-
* @docid
89+
* @namespace DevExpress.ui
90+
* @deprecated Use ToolbarItem instead
91+
*/
92+
export type dxCardViewToolbarItem = ToolbarItem;
93+
94+
/**
95+
* @docid dxCardViewToolbarItem
9096
* @inherits dxToolbarItem
9197
* @public
9298
* @namespace DevExpress.ui.dxCardView
9399
*/
94100
export type ToolbarItem = dxToolbarItem & {
95101
/**
96-
* @docid
102+
* @docid dxCardViewToolbarItem.name
97103
* @public
98104
*/
99105
name?: PredefinedToolbarItem | string;
100106
/**
101-
* @docid
107+
* @docid dxCardViewToolbarItem.location
102108
* @default 'after'
103109
* @public
104110
*/
105111
location?: ToolbarItemLocation;
106112
};
107113

108114
/**
109-
* @docid
115+
* @namespace DevExpress.ui
116+
* @deprecated Use Toolbar instead
117+
*/
118+
export type dxCardViewToolbar = Toolbar;
119+
120+
/**
121+
* @docid dxCardViewToolbar
110122
* @public
111123
* @namespace DevExpress.ui.dxCardView
112124
*/
113125
export type Toolbar = {
114126
/**
115-
* @docid
127+
* @docid dxCardViewToolbar.items
128+
* @type Array<Enums.PredefinedToolbarItem,dxCardViewToolbarItem>
116129
* @public
117130
*/
118131
items?: Array<PredefinedToolbarItem | ToolbarItem>;
119132
/**
120-
* @docid
133+
* @docid dxCardViewToolbar.visible
121134
* @default undefined
122135
* @public
123136
*/
124137
visible?: boolean | undefined;
125138
/**
126-
* @docid
139+
* @docid dxCardViewToolbar.disabled
127140
* @default false
128141
* @public
129142
*/
130143
disabled?: boolean;
131144
/**
132-
* @docid
145+
* @docid dxCardViewToolbar.multiline
133146
* @default false
134147
* @public
135148
*/
@@ -1537,6 +1550,7 @@ export interface dxCardViewOptions<TCardData = unknown, TKey = unknown> extends
15371550

15381551
/**
15391552
* @docid
1553+
* @type dxCardViewToolbar
15401554
* @public
15411555
*/
15421556
toolbar?: Toolbar;

packages/devextreme/ts/dx.all.d.ts

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10905,6 +10905,16 @@ declare module DevExpress.ui {
1090510905
e: DevExpress.ui.dxCardView.ContextMenuPreparingEvent<TCardData>
1090610906
) => void;
1090710907
}
10908+
/**
10909+
* @deprecated Use DevExpress.ui.dxCardView.Toolbar instead
10910+
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
10911+
*/
10912+
export type dxCardViewToolbar = DevExpress.ui.dxCardView.Toolbar;
10913+
/**
10914+
* @deprecated Use DevExpress.ui.dxCardView.ToolbarItem instead
10915+
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
10916+
*/
10917+
export type dxCardViewToolbarItem = DevExpress.ui.dxCardView.ToolbarItem;
1090810918
/**
1090910919
* [descr:dxChat]
1091010920
*/
@@ -33263,36 +33273,36 @@ declare module DevExpress.ui.dxCardView {
3326333273
grouping?: boolean;
3326433274
};
3326533275
/**
33266-
* [descr:Toolbar]
33276+
* [descr:dxCardViewToolbar]
3326733277
*/
3326833278
export type Toolbar = {
3326933279
/**
33270-
* [descr:Toolbar.items]
33280+
* [descr:dxCardViewToolbar.items]
3327133281
*/
3327233282
items?: Array<PredefinedToolbarItem | ToolbarItem>;
3327333283
/**
33274-
* [descr:Toolbar.visible]
33284+
* [descr:dxCardViewToolbar.visible]
3327533285
*/
3327633286
visible?: boolean | undefined;
3327733287
/**
33278-
* [descr:Toolbar.disabled]
33288+
* [descr:dxCardViewToolbar.disabled]
3327933289
*/
3328033290
disabled?: boolean;
3328133291
/**
33282-
* [descr:Toolbar.multiline]
33292+
* [descr:dxCardViewToolbar.multiline]
3328333293
*/
3328433294
multiline?: boolean;
3328533295
};
3328633296
/**
33287-
* [descr:ToolbarItem]
33297+
* [descr:dxCardViewToolbarItem]
3328833298
*/
3328933299
export type ToolbarItem = dxToolbarItem & {
3329033300
/**
33291-
* [descr:ToolbarItem.name]
33301+
* [descr:dxCardViewToolbarItem.name]
3329233302
*/
3329333303
name?: PredefinedToolbarItem | string;
3329433304
/**
33295-
* [descr:ToolbarItem.location]
33305+
* [descr:dxCardViewToolbarItem.location]
3329633306
*/
3329733307
location?: DevExpress.common.ToolbarItemLocation;
3329833308
};

tools/smd-cfg.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@
77
"kind": "remove",
88
"uid": "/ai-integration:AIIntegration"
99
},
10-
{
11-
"kind": "remove",
12-
"uid": "/card_view:Toolbar"
13-
},
1410
{
1511
"kind": "remove",
1612
"uid": "/html_editor:AICommand"
@@ -94,7 +90,6 @@
9490
"ui/accordion:dxAccordionItem",
9591
"ui/action_sheet:dxActionSheetItem",
9692
"ui/box:dxBoxItem",
97-
"ui/card_view:ToolbarItem",
9893
"ui/collection/ui.collection_widget.base:CollectionWidgetItem",
9994
"ui/drop_down_button:dxDropDownButtonItem",
10095
"ui/gallery:dxGalleryItem",

0 commit comments

Comments
 (0)