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

Add order #422

Merged
merged 1 commit into from
May 2, 2018
Merged

Add order #422

merged 1 commit into from
May 2, 2018

Conversation

brianvanburken
Copy link
Collaborator

Contribution Checklist

  • Each Value is an open record with a single field. The field's name is the value's name, and its type is Supported. For example foo : Value { provides | foo : Supported }
  • Each function returning Style accepts a closed record of Supported fields.
  • If a function returning Style takes a single Value, that Value should always support inherit, initial, and unset because all CSS properties support those three values! For example, borderFoo : Value { foo : Supported, bar : Supported, inherit : Supported, initial : Supported, unset : Supported } -> Style
  • If a function returning Style takes more than one Value, however, then none of its arguments should support inherit, initial, or unset, because these can never be used in conjunction with other values! For example, border-radius: 5px 5px; is valid CSS, border-radius: inherit; is valid CSS, but border-radius: 5px inherit; is invalid CSS. To reflect this, borderRadius : Value { ... } -> Style must have inherit : Supported in its record, but borderRadius2 : Value { ... } -> Value { ... } -> Style must not have inherit : Supported in either argument's record. If a user wants to get border-radius: inherit, they must call borderRadius, not borderRadius2!
  • Every exposed value has documentation which includes at least 1 code sample.
  • Documentation links to to a CSS Tricks article if available, and MDN if not.
  • Make a pull request against the phantom-types branch, not master!

@rtfeldman
Copy link
Owner

Great, thank you @brianvanburken!

{-| A unitless number. Useful with properties like [`flexGrow`](#flexGrow) which accept unitless numbers.
{-| A unitless number. Useful with properties like
[`flexGrow`](#flexGrow),
[`z-index`](https://css-tricks.com/almanac/properties/z/z-index/),
Copy link
Owner

Choose a reason for hiding this comment

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

Nice, thanks for adding zIndex to this!

No need to change (I'll take care of it post-merge) but quick note: for "Useful with properties like" examples, I'd like to link to the elm-css docs (e.g. [flexGrow](#flexGrow)) instead of MDN or CSS Tricks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for the feedback! I'll apply it next time I come across this :)

@rtfeldman rtfeldman merged commit 711ca38 into rtfeldman:phantom-types May 2, 2018
@brianvanburken brianvanburken deleted the phantom-types-order branch May 7, 2018 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants