Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit 9ad01ce

Browse files
chrisdholtchrisdholt
committed
update type exports and api-report
1 parent fa712fa commit 9ad01ce

File tree

2 files changed

+104
-95
lines changed

2 files changed

+104
-95
lines changed

‎docs/api-report.md‎

Lines changed: 85 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,44 @@
66

77
import { Anchor } from '@microsoft/fast-foundation';
88
import { AnchorOptions } from '@microsoft/fast-foundation';
9-
import { Badge } from '@microsoft/fast-foundation';
9+
import { Badge as Badge_2 } from '@microsoft/fast-foundation';
1010
import { BaseProgress } from '@microsoft/fast-foundation';
11-
import { Button } from '@microsoft/fast-foundation';
11+
import { Button as Button_2 } from '@microsoft/fast-foundation';
1212
import { ButtonOptions } from '@microsoft/fast-foundation';
13-
import { Checkbox } from '@microsoft/fast-foundation';
13+
import { Checkbox as Checkbox_2 } from '@microsoft/fast-foundation';
1414
import { CheckboxOptions } from '@microsoft/fast-foundation';
1515
import { Constructable } from '@microsoft/fast-element';
16-
import { DataGrid } from '@microsoft/fast-foundation';
17-
import { DataGridCell } from '@microsoft/fast-foundation';
18-
import { DataGridRow } from '@microsoft/fast-foundation';
19-
import { Divider } from '@microsoft/fast-foundation';
16+
import { DataGrid as DataGrid_2 } from '@microsoft/fast-foundation';
17+
import { DataGridCell as DataGridCell_2 } from '@microsoft/fast-foundation';
18+
import { DataGridRow as DataGridRow_2 } from '@microsoft/fast-foundation';
19+
import { Divider as Divider_2 } from '@microsoft/fast-foundation';
2020
import { FoundationElement } from '@microsoft/fast-foundation';
2121
import { FoundationElementDefinition } from '@microsoft/fast-foundation';
2222
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
2323
import { ListboxOption } from '@microsoft/fast-foundation';
2424
import { ListboxOptionOptions } from '@microsoft/fast-foundation';
2525
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
2626
import { ProgressRingOptions } from '@microsoft/fast-foundation';
27-
import { Radio } from '@microsoft/fast-foundation';
28-
import { RadioGroup } from '@microsoft/fast-foundation';
27+
import { Radio as Radio_2 } from '@microsoft/fast-foundation';
28+
import { RadioGroup as RadioGroup_2 } from '@microsoft/fast-foundation';
2929
import { RadioOptions } from '@microsoft/fast-foundation';
3030
import { Select } from '@microsoft/fast-foundation';
3131
import { SelectOptions } from '@microsoft/fast-foundation';
3232
import { Tab } from '@microsoft/fast-foundation';
3333
import { TabPanel } from '@microsoft/fast-foundation';
3434
import { Tabs } from '@microsoft/fast-foundation';
35-
import { TextArea } from '@microsoft/fast-foundation';
36-
import { TextField } from '@microsoft/fast-foundation';
35+
import { TextArea as TextArea_2 } from '@microsoft/fast-foundation';
36+
import { TextField as TextField_2 } from '@microsoft/fast-foundation';
3737
import { TextFieldOptions } from '@microsoft/fast-foundation';
3838

3939
// @public
40-
export type ButtonAppearance = 'primary' | 'secondary' | 'icon';
41-
42-
// @public
43-
export class VSCodeBadge extends Badge {
40+
export class Badge extends Badge_2 {
4441
// @internal
4542
connectedCallback(): void;
4643
}
4744

4845
// @public
49-
export const vsCodeBadge: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeBadge>;
50-
51-
// @public
52-
export class VSCodeButton extends Button {
46+
export class Button extends Button_2 {
5347
appearance: ButtonAppearance;
5448
// @internal
5549
attributeChangedCallback(attrName: string, oldVal: string, newVal: string): void;
@@ -58,147 +52,162 @@ export class VSCodeButton extends Button {
5852
}
5953

6054
// @public
61-
export const vsCodeButton: (overrideDefinition?: OverrideFoundationElementDefinition<ButtonOptions> | undefined) => FoundationElementRegistry<ButtonOptions, Constructable<FoundationElement>>;
55+
export type ButtonAppearance = 'primary' | 'secondary' | 'icon';
6256

6357
// @public
64-
export class VSCodeCheckbox extends Checkbox {
58+
export class Checkbox extends Checkbox_2 {
6559
// @internal
6660
connectedCallback(): void;
6761
}
6862

6963
// @public
70-
export const vsCodeCheckbox: (overrideDefinition?: OverrideFoundationElementDefinition<CheckboxOptions> | undefined) => FoundationElementRegistry<CheckboxOptions, Constructable<FoundationElement>>;
71-
72-
// @public
73-
export class VSCodeDataGrid extends DataGrid {
64+
export class DataGrid extends DataGrid_2 {
7465
// @internal
7566
connectedCallback(): void;
7667
}
7768

7869
// @public
79-
export const vsCodeDataGrid: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeDataGrid>;
70+
export class DataGridCell extends DataGridCell_2 {
71+
}
8072

8173
// @public
82-
export class VSCodeDataGridCell extends DataGridCell {
74+
export class DataGridRow extends DataGridRow_2 {
8375
}
8476

8577
// @public
86-
export const vsCodeDataGridCell: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeDataGridCell>;
78+
export class Divider extends Divider_2 {
79+
}
8780

8881
// @public
89-
export class VSCodeDataGridRow extends DataGridRow {
82+
export class Dropdown extends Select {
9083
}
9184

9285
// @public
93-
export const vsCodeDataGridRow: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeDataGridRow>;
86+
export class DropdownOption extends ListboxOption {
87+
// @internal
88+
connectedCallback(): void;
89+
}
90+
91+
// @public
92+
export type DropdownOptionOptions = ListboxOptionOptions;
93+
94+
// @public
95+
export type DropdownOptions = SelectOptions;
9496

9597
// @public
96-
export class VSCodeDivider extends Divider {
98+
export class Link extends Anchor {
9799
}
98100

99101
// @public
100-
export const vsCodeDivider: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeDivider>;
102+
export type LinkOptions = AnchorOptions;
101103

102104
// @public
103-
export class VSCodeDropdown extends Select {
105+
export class Panels extends Tabs {
106+
// @internal
107+
connectedCallback(): void;
104108
}
105109

106110
// @public
107-
export const vsCodeDropdown: (overrideDefinition?: OverrideFoundationElementDefinition<SelectOptions> | undefined) => FoundationElementRegistry<SelectOptions, Constructable<FoundationElement>>;
111+
export class PanelTab extends Tab {
112+
// @internal
113+
connectedCallback(): void;
114+
}
108115

109116
// @public
110-
export class VSCodeLink extends Anchor {
117+
export class PanelView extends TabPanel {
111118
}
112119

113120
// @public
114-
export const vsCodeLink: (overrideDefinition?: OverrideFoundationElementDefinition<AnchorOptions> | undefined) => FoundationElementRegistry<AnchorOptions, Constructable<FoundationElement>>;
121+
export class ProgressRing extends BaseProgress {
122+
// @internal
123+
attributeChangedCallback(attrName: string, oldVal: string, newVal: string): void;
124+
// @internal
125+
connectedCallback(): void;
126+
}
115127

116128
// @public
117-
export class VSCodeOption extends ListboxOption {
129+
export class Radio extends Radio_2 {
118130
// @internal
119131
connectedCallback(): void;
120132
}
121133

122134
// @public
123-
export const vsCodeOption: (overrideDefinition?: OverrideFoundationElementDefinition<ListboxOptionOptions> | undefined) => FoundationElementRegistry<ListboxOptionOptions, Constructable<FoundationElement>>;
135+
export class RadioGroup extends RadioGroup_2 {
136+
// @internal
137+
connectedCallback(): void;
138+
}
124139

125140
// @public
126-
export class VSCodePanels extends Tabs {
141+
export class Tag extends Badge_2 {
127142
// @internal
128143
connectedCallback(): void;
129144
}
130145

131146
// @public
132-
export const vsCodePanels: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodePanels>;
147+
export class TextArea extends TextArea_2 {
148+
// @internal
149+
connectedCallback(): void;
150+
}
133151

134152
// @public
135-
export class VSCodePanelTab extends Tab {
153+
export class TextField extends TextField_2 {
136154
// @internal
137155
connectedCallback(): void;
138156
}
139157

140158
// @public
141-
export const vsCodePanelTab: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodePanelTab>;
159+
export const vsCodeBadge: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof Badge>;
142160

143161
// @public
144-
export class VSCodePanelView extends TabPanel {
145-
}
162+
export const vsCodeButton: (overrideDefinition?: OverrideFoundationElementDefinition<ButtonOptions> | undefined) => FoundationElementRegistry<ButtonOptions, Constructable<FoundationElement>>;
146163

147164
// @public
148-
export const vsCodePanelView: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodePanelView>;
165+
export const vsCodeCheckbox: (overrideDefinition?: OverrideFoundationElementDefinition<CheckboxOptions> | undefined) => FoundationElementRegistry<CheckboxOptions, Constructable<FoundationElement>>;
149166

150167
// @public
151-
export class VSCodeProgressRing extends BaseProgress {
152-
// @internal
153-
attributeChangedCallback(attrName: string, oldVal: string, newVal: string): void;
154-
// @internal
155-
connectedCallback(): void;
156-
}
168+
export const vsCodeDataGrid: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof DataGrid>;
157169

158170
// @public
159-
export const vsCodeProgressRing: (overrideDefinition?: OverrideFoundationElementDefinition<ProgressRingOptions> | undefined) => FoundationElementRegistry<ProgressRingOptions, Constructable<FoundationElement>>;
171+
export const vsCodeDataGridCell: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof DataGridCell>;
160172

161173
// @public
162-
export class VSCodeRadio extends Radio {
163-
// @internal
164-
connectedCallback(): void;
165-
}
174+
export const vsCodeDataGridRow: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof DataGridRow>;
166175

167176
// @public
168-
export const vsCodeRadio: (overrideDefinition?: OverrideFoundationElementDefinition<RadioOptions> | undefined) => FoundationElementRegistry<RadioOptions, Constructable<FoundationElement>>;
177+
export const vsCodeDivider: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof Divider>;
169178

170179
// @public
171-
export class VSCodeRadioGroup extends RadioGroup {
172-
// @internal
173-
connectedCallback(): void;
174-
}
180+
export const vsCodeDropdown: (overrideDefinition?: OverrideFoundationElementDefinition<SelectOptions> | undefined) => FoundationElementRegistry<SelectOptions, Constructable<FoundationElement>>;
175181

176182
// @public
177-
export const vsCodeRadioGroup: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeRadioGroup>;
183+
export const vsCodeLink: (overrideDefinition?: OverrideFoundationElementDefinition<AnchorOptions> | undefined) => FoundationElementRegistry<AnchorOptions, Constructable<FoundationElement>>;
178184

179185
// @public
180-
export class VSCodeTag extends Badge {
181-
// @internal
182-
connectedCallback(): void;
183-
}
186+
export const vsCodeOption: (overrideDefinition?: OverrideFoundationElementDefinition<ListboxOptionOptions> | undefined) => FoundationElementRegistry<ListboxOptionOptions, Constructable<FoundationElement>>;
184187

185188
// @public
186-
export const vsCodeTag: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeTag>;
189+
export const vsCodePanels: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof Panels>;
187190

188191
// @public
189-
export class VSCodeTextArea extends TextArea {
190-
// @internal
191-
connectedCallback(): void;
192-
}
192+
export const vsCodePanelTab: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof PanelTab>;
193193

194194
// @public
195-
export const vsCodeTextArea: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof VSCodeTextArea>;
195+
export const vsCodePanelView: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof PanelView>;
196196

197197
// @public
198-
export class VSCodeTextField extends TextField {
199-
// @internal
200-
connectedCallback(): void;
201-
}
198+
export const vsCodeProgressRing: (overrideDefinition?: OverrideFoundationElementDefinition<ProgressRingOptions> | undefined) => FoundationElementRegistry<ProgressRingOptions, Constructable<FoundationElement>>;
199+
200+
// @public
201+
export const vsCodeRadio: (overrideDefinition?: OverrideFoundationElementDefinition<RadioOptions> | undefined) => FoundationElementRegistry<RadioOptions, Constructable<FoundationElement>>;
202+
203+
// @public
204+
export const vsCodeRadioGroup: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof RadioGroup>;
205+
206+
// @public
207+
export const vsCodeTag: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof Tag>;
208+
209+
// @public
210+
export const vsCodeTextArea: (overrideDefinition?: OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => FoundationElementRegistry<FoundationElementDefinition, typeof TextArea>;
202211

203212
// @public
204213
export const vsCodeTextField: (overrideDefinition?: OverrideFoundationElementDefinition<TextFieldOptions> | undefined) => FoundationElementRegistry<TextFieldOptions, Constructable<FoundationElement>>;

‎src/custom-elements.ts‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,29 +24,29 @@ import {vsCodeTextField} from './text-field/index';
2424
// Don't delete these. They're needed so that API-extractor doesn't add import types
2525
// with improper pathing
2626
/* eslint-disable @typescript-eslint/no-unused-vars */
27-
import type {VSCodeBadge} from './badge/index';
28-
import type {VSCodeButton} from './button/index';
29-
import type {VSCodeCheckbox} from './checkbox/index';
27+
import type {Badge} from './badge/index';
28+
import type {Button} from './button/index';
29+
import type {Checkbox} from './checkbox/index';
3030
import type {
31-
VSCodeDataGrid,
32-
VSCodeDataGridCell,
33-
VSCodeDataGridRow,
31+
DataGrid,
32+
DataGridCell,
33+
DataGridRow,
3434
} from './data-grid/index';
35-
import type {VSCodeDivider} from './divider/index';
36-
import type {VSCodeDropdown} from './dropdown/index';
37-
import type {VSCodeLink} from './link/index';
38-
import type {VSCodeOption} from './option/index';
35+
import type {Divider} from './divider/index';
36+
import type {Dropdown} from './dropdown/index';
37+
import type {Link} from './link/index';
38+
import type {DropdownOption} from './option/index';
3939
import type {
40-
VSCodePanels,
41-
VSCodePanelTab,
42-
VSCodePanelView,
40+
Panels,
41+
PanelTab,
42+
PanelView,
4343
} from './panels/index';
44-
import type {VSCodeProgressRing} from './progress-ring/index';
45-
import type {VSCodeRadioGroup} from './radio-group/index';
46-
import type {VSCodeRadio} from './radio/index';
47-
import type {VSCodeTag} from './tag/index';
48-
import type {VSCodeTextArea} from './text-area/index';
49-
import type {VSCodeTextField} from './text-field/index';
44+
import type {ProgressRing} from './progress-ring/index';
45+
import type {RadioGroup} from './radio-group/index';
46+
import type {Radio} from './radio/index';
47+
import type {Tag} from './tag/index';
48+
import type {TextArea} from './text-area/index';
49+
import type {TextField} from './text-field/index';
5050

5151
// When adding new components, make sure to add the component to the `allComponents` object
5252
// in addition to exporting the component by name. Ideally we would be able to just add

0 commit comments

Comments
 (0)