Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(radio-button-group): strongly type dispatched change/select events #1819

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions COMPONENT_INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -2983,13 +2983,13 @@ None.

### Events

| Event name | Type | Detail |
| :--------- | :--------- | :----- |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
| change | dispatched | -- |
| Event name | Type | Detail |
| :--------- | :--------- | :------------------ |
| change | dispatched | <code>string</code> |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |

## `RadioButtonSkeleton`

Expand Down Expand Up @@ -4251,9 +4251,9 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100";

### Events

| Event name | Type | Detail |
| :--------- | :--------- | :----- |
| select | dispatched | -- |
| Event name | Type | Detail |
| :--------- | :--------- | :------------------ |
| select | dispatched | <code>string</code> |

## `TimePicker`

Expand Down
8 changes: 5 additions & 3 deletions docs/src/COMPONENT_API.json
Original file line number Diff line number Diff line change
Expand Up @@ -9615,11 +9615,11 @@
}
],
"events": [
{ "type": "dispatched", "name": "change", "detail": "string" },
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "change" }
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
Expand Down Expand Up @@ -13158,7 +13158,9 @@
],
"moduleExports": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "dispatched", "name": "select" }],
"events": [
{ "type": "dispatched", "name": "select", "detail": "string" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "fieldset" }
},
Expand Down
4 changes: 4 additions & 0 deletions src/RadioButtonGroup/RadioButtonGroup.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<script>
/**
* @event {string} change
*/

/**
* Set the selected radio button value
* @type {string}
Expand Down
4 changes: 4 additions & 0 deletions src/Tile/TileGroup.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<script>
/**
* @event {string} select
*/

/**
* Specify the selected tile value
* @type {string}
Expand Down
8 changes: 7 additions & 1 deletion tests/RadioButton.test.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
import { RadioButton, RadioButtonSkeleton, RadioButtonGroup } from "../types";
</script>

<RadioButtonGroup legendText="Storage tier (disk)" selected="standard">
<RadioButtonGroup
legendText="Storage tier (disk)"
selected="standard"
on:change="{(e) => {
console.log(e.detail); // string
}}"
>
<RadioButton labelText="Free (1 GB)" value="free" />
<RadioButton labelText="Standard (10 GB)" value="standard" />
<RadioButton labelText="Pro (128 GB)" value="pro" />
Expand Down
12 changes: 10 additions & 2 deletions tests/RadioTile.test.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
import { TileGroup, RadioTile } from "../types";
</script>

<TileGroup name="plan" required legend="Service pricing tiers">
<RadioTile light value="0" checked>Lite plan</RadioTile>
<TileGroup
name="plan"
required
legend="Service pricing tiers"
selected="0"
on:select="{(e) => {
console.log(e.detail); // string
}}"
>
<RadioTile light checked value="0">Lite plan</RadioTile>
<RadioTile value="1">Standard plan</RadioTile>
<RadioTile value="2">Plus plan</RadioTile>
</TileGroup>
2 changes: 1 addition & 1 deletion types/RadioButtonGroup/RadioButtonGroup.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ export interface RadioButtonGroupProps extends RestProps {
export default class RadioButtonGroup extends SvelteComponentTyped<
RadioButtonGroupProps,
{
change: CustomEvent<string>;
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
change: CustomEvent<any>;
},
{ default: {}; legendText: {} }
> {}
2 changes: 1 addition & 1 deletion types/Tile/TileGroup.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ export interface TileGroupProps extends RestProps {

export default class TileGroup extends SvelteComponentTyped<
TileGroupProps,
{ select: CustomEvent<any> },
{ select: CustomEvent<string> },
{ default: {} }
> {}