Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

docs(css): Add support for <string> in syntax descriptor of @property at-rule #36655

Merged
merged 9 commits into from
Nov 19, 2024
Merged

docs(css): Add support for <string> in syntax descriptor of @property at-rule #36655

merged 9 commits into from
Nov 19, 2024

Conversation

dipikabh
Copy link
Contributor

@dipikabh dipikabh commented Nov 5, 2024 •
edited
Loading

Description

With the update of the "CSS Properties and Values API" specification via w3c/css-houdini-drafts#1104, <string> is now a supported syntax component name.

The update has also been shipped in stable versions of Firefox and Chrome (BCD).

This PR adds <string> to the list on the syntax page.

Additional details

This PR also updates the @property at-rule and its related descriptors: inherits, initial-value, and syntax.

Some common updates across the pages include:

  • Intro para

    • Normalized the writing style to be consistent with other descriptor reference pages.
    • Followed the order of first explaining what is it and then stating whether it's required and what happens if its missing or invalid

  • "Syntax" section

    • @property: Updated so that it is a complete example (replaced --property-name) and is different from the one used in the "Examples" section
    • Descriptor pages: Updated to show only the descriptor line and added comments (this is similar to the format followed on the syntax page)

  • "Values" section

    • Changed it to an H3

  • "Examples" section

    • Added a task-oriented H3 and updated prose to make it specific for the page

  • "See also" section

    • Added links to other @property descriptor pages

Page-specific updates

  • @property page

    • Added an explanation for the missing property name
    • Updated the "Descriptors" section to move out syntax details to the syntax descriptor reference page
    • Added the "Description" section to capture the conditions for a valid @property

  • @property/syntax page

    • Added more examples to the "Syntax" block
    • Reorganized the "Values" section to better explain syntax strings and syntax component names (terms referred in the specification)
    • Clarified the difference between data type names, keywords, and *
    • Reordered the list of supported syntax component names in alphabetical order
    • Fixed the description of "<length-percentage>"

Related issues

#28838

@dipikabh dipikabh requested a review from a team as a code owner November 5, 2024 04:27
@dipikabh dipikabh requested review from chrisdavidmills and removed request for a team November 5, 2024 04:27
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs size/m [PR only] 51-500 LoC changed labels Nov 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024 •
edited
Loading

Preview URLs

External URLs (1)

URL: /en-US/docs/Mozilla/Firefox/Releases/128
Title: Firefox 128 for developers

(comment last updated: 2024-11-19 09:01:39)

@dipikabh dipikabh requested a review from a team as a code owner November 5, 2024 04:41
@dipikabh dipikabh requested review from bsmth and removed request for a team November 5, 2024 04:41
@github-actions github-actions bot added the Content:Firefox Content in the Mozilla/Firefox subtree label Nov 5, 2024
@bsmth bsmth mentioned this pull request Nov 12, 2024
Closed
@bsmth bsmth self-assigned this Nov 14, 2024
bsmth
bsmth approved these changes Nov 14, 2024
View reviewed changes
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Looking really good, thanks a lot! 👍🏻

@bsmth bsmth merged commit 6834ad6 into mdn:main Nov 19, 2024
8 checks passed
wbamberg added a commit to wbamberg/content that referenced this pull request Nov 27, 2024
@wbamberg
Merge remote-tracking branch 'origin/xss-guide' into xss-guide
bc9d568 
* origin/xss-guide: (284 commits)
  Add information on default entryPoint property values (mdn#36633)
  Bump husky from 9.1.6 to 9.1.7 (mdn#36863)
  fix(performance): Typo '50ms seconds' (mdn#36861)
  Add spec_url & add note for bcd for `<frequency>` and `<frequency-percentage>` (mdn#36848)
  addresses 36583: summary icon styles (mdn#36691)
  Remove "simple" part 3: change to "basic"  (mdn#36762)
  the default option of a select (mdn#36658)
  docs(css): Add support for `<string>` in `syntax` descriptor of @Property at-rule (mdn#36655)
  Fix parameter syntax for `Navigation.updateCurrentEntry()` (mdn#36852)
  Update CSP source expression reference (mdn#36792)
  chore(http): Refresh headers docs (d-k) (mdn#36075)
  chore(http): Refresh headers r-s (mdn#36590)
  Updated index.md (mdn#36845)
  fix : wrong method name (mdn#36843)
  Remove all redirects to other locales (mdn#36811)
  fix typos (mdn#36837)
  docs: update Accept-Charset status (mdn#36822)
  updateSelection: make more intuitive (mdn#36834)
  updateText: Remove false information (mdn#36832)
  DOMRect instance properties (mdn#36704)
  ...
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@bsmth bsmth bsmth approved these changes

@chrisdavidmills chrisdavidmills Awaiting requested review from chrisdavidmills chrisdavidmills is a code owner automatically assigned from mdn/yari-content-css

Assignees

@bsmth bsmth

Labels
Content:CSS Cascading Style Sheets docs Content:Firefox Content in the Mozilla/Firefox subtree size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dipikabh @bsmth