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

Web-components: Fix custom-elements order of property application #19183

Merged
merged 9 commits into from
Jun 9, 2023
Merged

Web-components: Fix custom-elements order of property application #19183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1cb81e8
sb-button web component: Added prefix slot in example
Sep 14, 2022
12b80b2
Updated tests for web components.
Sep 14, 2022
1f44525
Merge branch 'next' into pr/19183
shilman Oct 27, 2022
45d38a4
Merge branch 'next' into pr/19183
shilman Oct 31, 2022
175512e
Merge branch 'next' into sonntag-philipp/issues-19167-18858-custom-el…
ndelangen Jan 13, 2023
2254105
Merge branch 'next' into sonntag-philipp/issues-19167-18858-custom-el…
yannbf Apr 19, 2023
addfb99
Merge branch 'next' into pr/19183
shilman Jun 9, 2023
2505a80
Merge branch 'next' into pr/19183
shilman Jun 9, 2023
0bc5afc
Merge branch 'next' into pr/19183
shilman Jun 9, 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
6 changes: 3 additions & 3 deletions ...derers/web-components/src/docs/__testfixtures__/lit-element-demo-card/properties.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Object {
},
},
"type": Object {
"name": "void",
"name": "boolean",
},
},
"backSide": Object {
Expand Down Expand Up @@ -126,7 +126,7 @@ Object {
"name": "header",
"required": false,
"table": Object {
"category": "properties",
"category": "attributes",
"defaultValue": Object {
"summary": "\\"Your Message\\"",
},
Expand All @@ -152,7 +152,7 @@ Object {
"name": "rows",
"required": false,
"table": Object {
"category": "properties",
"category": "attributes",
"defaultValue": Object {
"summary": "[]",
},
Expand Down
17 changes: 14 additions & 3 deletions code/renderers/web-components/src/docs/custom-elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,19 @@ interface Declaration {
}

function mapItem(item: TagItem, category: string): InputType {
const type =
category === 'properties' ? { name: item.type?.text || item.type } : { name: 'void' };
let type;
switch (category) {
case 'attributes':
case 'properties':
type = { name: item.type?.text || item.type };
break;
case 'slots':
type = { name: 'string' };
break;
default:
type = { name: 'void' };
break;
}
Copy link
Contributor

@usrrname usrrname Apr 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, and sorely needed! I'd contemplate bringing this into @storybook/html as well re: transformation of attributes as opposed to properties to args. I say this because it's an easy conflation to newcomers and having a way to distinguish these... would make onboarding to WC DS much easier.


return {
name: item.name,
Expand Down Expand Up @@ -139,9 +150,9 @@ export const extractArgTypesFromElements = (tagName: string, customElements: Cus
const metaData = getMetaData(tagName, customElements);
return (
metaData && {
...mapData(metaData.attributes ?? [], 'attributes'),
...mapData(metaData.members ?? [], 'properties'),
...mapData(metaData.properties ?? [], 'properties'),
...mapData(metaData.attributes ?? [], 'attributes'),
...mapData(metaData.events ?? [], 'events'),
...mapData(metaData.slots ?? [], 'slots'),
...mapData(metaData.cssProperties ?? [], 'css custom properties'),
Expand Down
4 changes: 2 additions & 2 deletions code/renderers/web-components/template/stories/custom-elements.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
],
"slots": [
{
"description": "This is an unnamed slot (the default slot)",
"name": ""
"name": "prefix",
"description": "Label prefix"
}
],
"members": [
Expand Down
24 changes: 16 additions & 8 deletions code/renderers/web-components/template/stories/demo-wc-card.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@ import './demo-wc-card';

export default {
component: 'demo-wc-card',
render: ({ backSide, header, rows, prefix }) =>
html`
<demo-wc-card .backSide="${backSide}" .header="${header}" .rows="${rows}"
><span slot="prefix">${prefix}</span>A simple card</demo-wc-card
>
`,
};

const Template = ({ backSide, header, rows }) =>
html`
<demo-wc-card .backSide="${backSide}" .header="${header}" .rows="${rows}"
>A simple card</demo-wc-card
>
`;
export const Front = {
args: { backSide: false, header: undefined, rows: [] },
};

export const Back = {
args: { backSide: true, header: undefined, rows: [] },
};

export const Front = Template.bind({});
Front.args = { backSide: false, header: undefined, rows: [] };
export const Prefix = {
args: { backSide: false, prefix: 'prefix:', header: 'my header', rows: [] },
};
2 changes: 1 addition & 1 deletion code/renderers/web-components/template/stories/demo-wc-card/DemoWcCard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export class DemoWcCard extends LitElement {
</div>
</div>
<div id="back" part="back">
<div class="header">${this.header}</div>
<div class="header"><slot name="prefix"></slot> ${this.header}</div>

<div class="content">
${this.rows.length === 0
Expand Down