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 type of template getter in element-mixin.html #5519

Merged
merged 3 commits into from
Apr 9, 2019
Merged

Conversation

bro314
Copy link

@bro314 bro314 commented Apr 9, 2019

Fix type of template getter in element-mixin.html

Fixes #5443

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes and removed cla: no labels Apr 9, 2019
Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

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

Pending approval by @rictic

@TimvdLippe TimvdLippe requested a review from rictic April 9, 2019 14:16
@arthurevans
Copy link

Just to note, the docs currently recommend returning null in one specific (probably very rare) circumstance--if you're extending an element with a template, but you don't want your element to have one. https://polymer-library.polymer-project.org/3.0/docs/devguide/dom-template#elements-with-no-shadow-dom

If the strict template changes changed this behavior, we should update the docs, but pinging @kevinpschaaf here in case he has input.

@rictic
Copy link
Contributor

rictic commented Apr 9, 2019

As I read it, this method can return either undefined or null.

undefined if the mixed-in element doesn't have a template, either as a dom-module or inline.

null if the mixed-in element explicitly declares a null template, as we recommend that you do if it's an element with no template (like e.g. iron-ajax)

I'd prefer:

{string|!HTMLTemplateElement|null|undefined}

@bro314
Copy link
Author

bro314 commented Apr 9, 2019

Done. PTAL

@bro314
Copy link
Author

bro314 commented Apr 9, 2019

HTMLTemplateElement without ! implicitly means nullable, so I think just removing the ! from the setter parameter type comment is the way to go. Changed both to {HTMLTemplateElement|string}. PTAL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants