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.

Sign up for GitHub

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

feat(tile): add custom event to selected-tile #9898

Merged
merged 2 commits into from
Jan 17, 2023
Merged

feat(tile): add custom event to selected-tile #9898

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8362a6a
feat(tile): add selected event to selected-tile
kennylam Jan 10, 2023
74d08e7
Merge branch 'main' into feat/selectable-tile-add-event-9740
kodiakhq[bot] Jan 17, 2023
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
22 changes: 21 additions & 1 deletion packages/carbon-web-components/src/components/tile/selectable-tile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @license
*
* Copyright IBM Corp. 2019, 2022
* Copyright IBM Corp. 2019, 2023
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
Expand Down Expand Up @@ -29,6 +29,7 @@ const { prefix } = settings;
* Multi-selectable tile.
*
* @element bx-selectable-tile
* @fires bx-selectable-tile-changed - The custom event fired after this selectable tile changes its selected state.
*/
@customElement(`${prefix}-selectable-tile`)
class BXSelectableTile extends FocusMixin(LitElement) {
Expand All @@ -45,6 +46,18 @@ class BXSelectableTile extends FocusMixin(LitElement) {
*/
protected _handleChange() {
this.selected = this._inputNode.checked;

const selected = this.selected;
const { eventChange } = this.constructor as typeof BXSelectableTile;
this.dispatchEvent(
new CustomEvent(eventChange, {
bubbles: true,
composed: true,
detail: {
selected,
},
})
);
}

/**
Expand Down Expand Up @@ -124,6 +137,13 @@ class BXSelectableTile extends FocusMixin(LitElement) {
`;
}

/**
* The name of the custom event fired after this selectable tile changes its selected state.
*/
static get eventChange() {
return `${prefix}-selectable-tile-changed`;
}

static styles = styles;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/carbon-web-components/src/components/tile/tile-story.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Note: For `boolean` attributes, `true` means simply setting the attribute (e.g.
</bx-selectable-tile>
```

## `<bx-selectable-tile>` attributes and properties
## `<bx-selectable-tile>` attributes and properties and events

Note: For `boolean` attributes, `true` means simply setting the attribute (e.g.
`<bx-selectable-tile selected>`) and `false` means not setting the attribute
Expand Down