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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix interpolations in https://www.fast.design/docs/fast-element/using-directives#host-directives #6475

Closed
engelsdamien opened this issue Oct 26, 2022 · 2 comments
Labels
area:fast-element Pertains to fast-element community:good-first-issue Good issues for first time contributors docs:article Additions, improvements, or fixes to site articles status:planned Work is planned

Comments

@engelsdamien
Copy link

馃檵 Documentation Request

The first example in https://www.fast.design/docs/fast-element/using-directives#host-directives has a few typos:

const template = html<MyProgress>`
  <template (Represents my-progress element)
      role="progressbar"
      $aria-valuenow={x => x.value}
      $aria-valuemin={x => x.min}
      $aria-valuemax={x => x.max}>
    (template targeted at Shadow DOM here)
  </template>
`;

馃拋 Possible Solution

It should likely be:

const template = html<MyProgress>`
  <template (Represents my-progress element)
      role="progressbar"
      aria-valuenow=${x => x.value}
      aria-valuemin=${x => x.min}
      aria-valuemax=${x => x.max}>
    (template targeted at Shadow DOM here)
  </template>
`;
@engelsdamien engelsdamien added the status:triage New Issue - needs triage label Oct 26, 2022
@EisenbergEffect EisenbergEffect added docs:article Additions, improvements, or fixes to site articles status:planned Work is planned area:fast-element Pertains to fast-element labels Oct 27, 2022
@EisenbergEffect EisenbergEffect self-assigned this Oct 27, 2022
@EisenbergEffect EisenbergEffect added this to the FAST Element 2.0 milestone Oct 27, 2022
@EisenbergEffect
Copy link
Contributor

Wow. Good catch. This was some documentation from the early version of fast-element when it was pre v1.0 and we were still thinking of using $ for attributes. Must have gotten missed when we updated things.

@EisenbergEffect EisenbergEffect removed the status:triage New Issue - needs triage label Oct 27, 2022
@EisenbergEffect EisenbergEffect removed their assignment Dec 7, 2022
@chrisdholt chrisdholt added the community:good-first-issue Good issues for first time contributors label Dec 15, 2022
@janechu
Copy link
Collaborator

janechu commented May 29, 2024

This is actively being worked on for the v2 docs for @microsoft/fast-element and has been addressed.

@janechu janechu closed this as completed May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:fast-element Pertains to fast-element community:good-first-issue Good issues for first time contributors docs:article Additions, improvements, or fixes to site articles status:planned Work is planned
Projects
Status: Done
Development

No branches or pull requests

4 participants