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

New page: overflow values #26395

Merged
merged 21 commits into from
Apr 28, 2023
Merged

New page: overflow values #26395

merged 21 commits into from
Apr 28, 2023

Conversation

estelle
Copy link
Member

@estelle estelle commented Apr 24, 2023

The <overflow> values are used in multiple properties. Instead of defining the values in each location, we can provide a deep dive in one location and refer to this page when using the value type.

@estelle estelle requested a review from a team as a code owner April 24, 2023 22:22
@estelle estelle requested review from dipikabh and removed request for a team April 24, 2023 22:22
@github-actions github-actions bot added the Content:CSS Cascading Style Sheets docs label Apr 24, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Apr 24, 2023

Preview URLs

Flaws (1)

URL: /en-US/docs/Web/CSS/overflow_value
Title: <overflow>
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: css.types.overflow

(comment last updated: 2023-04-27 20:07:15)

@dipikabh
Copy link
Contributor

Thanks, @estelle. I'll start reviewing this tomorrow.

@dipikabh dipikabh self-assigned this Apr 24, 2023
@dipikabh
Copy link
Contributor

Hi @estelle, the Overflow specification does not define <overflow> as a data type. Would it be correct to document it as one?

Could we instead use the overflow property page as the deep dive location for the values and link other overflow-* property values to the overflow property page?

As an example of a property-* page, min-block-size values and min-inline-size values do this and also the inset-* properties.

As an aside - I don't think there is any other "_value" data type page (overflow_value used in the slug for the new page) in the "Types" sidebar grouping.

@estelle
Copy link
Member Author

estelle commented Apr 25, 2023

Hi @estelle, the Overflow specification does not define <overflow> as a data type. Would it be correct to document it as one?

It doesn't defined it as a data type. Similar to <line-style>, it's an enumerated value type, so let's go with that, "enumerated value type", categorized as a data-type for page types, but not listing the term.

As an aside - I don't think there is any other "_value" data type page (overflow_value used in the slug for the new page) in the "Types" sidebar grouping.

as overflow is a property, i couldn't use that as the slug. i grabbed the slug idea from color_value as color is also a property.

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Getting around to the idea of having a page for enumerated value type! Suggested some edits and rephrasing

Comment on lines +3 to +4
slug: Web/CSS/overflow_value
page-type: css-type
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
slug: Web/CSS/overflow_value
page-type: css-type
slug: Web/CSS/overflow_values
page-type: css-value-type

or maybe page-type: css-enumerated-value-type?

Just a suggestion for a different page type. We might want to try a different page type for these types of pages. You'd have better ideas here.

Copy link
Member Author

Choose a reason for hiding this comment

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

for now, we are adding this as a regular value type. We can change if we think it doesn't work live.
For the slug, other CSS data types use "value" not "values.

title: <overflow>
slug: Web/CSS/overflow_value
page-type: css-type
browser-compat: css.types.overflow
Copy link
Contributor

Choose a reason for hiding this comment

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

The bcd file location will also need to change. A new folder for values?

There's folders for at-rules, selectors, properties, and types at present.

Copy link
Member Author

Choose a reason for hiding this comment

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

we're pretending this is a regular data type for now: it's just enumerated rather than functional or numeric like the other ones

files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/overflow_value/index.md Outdated Show resolved Hide resolved

### Results

{{EmbedLiveSample("Examples", "500", "600")}}
Copy link
Contributor

Choose a reason for hiding this comment

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

You might want to increase the length of the iframe here to contain all the examples

files/en-us/web/css/overflow_value/index.md Show resolved Hide resolved
estelle and others added 2 commits April 26, 2023 22:00
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
estelle and others added 4 commits April 26, 2023 22:03
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
@estelle estelle requested a review from dipikabh April 27, 2023 05:07
Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thank you for the updates!

@dipikabh dipikabh merged commit 39a624b into mdn:main Apr 28, 2023
@estelle estelle deleted the overflowValue branch August 3, 2023 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants