angular / components

Component infrastructure and Material Design components for Angular
https://material.angular.io
MIT License
24.32k stars 6.72k forks source link

MatFormField documentation should prefer outline/fill style #14792

Closed jelbourn closed 4 years ago

jelbourn commented 5 years ago

In the most recent Material Design update, the "standard" / "legacy" style is now omitted from the spec with only the outline and fill styles remaining. We should update our own documentation and examples to reflect this update.

mainawycliffe commented 5 years ago

Do you mean the legacy and standard options are no longer supported? I am interested in taking up this as my first issue.

jelbourn commented 5 years ago

This issue is just about the documentation preferring one setting over the other. Feel free to send a PR!

mainawycliffe commented 5 years ago

Will do

karismann commented 5 years ago

I found the link to the doc if it can help : https://material.io/design/components/text-fields.html#usage What's the default appearance for the form-field now ? outline or filled?

I think this default affectation of appearance in the MatFormFieldclass is also impacted, am I right ?

mainawycliffe commented 5 years ago

I am providing an example for both in the overview (basic) example, then using mainly outline over filled, assuming once you see the overview example you get the basic idea. The material spec isn't clear on which is the default appearance of a text field. I will send a PR tonight.

Suresh918 commented 5 years ago

Hi jelbourn, It would be helpful if you provide the default appearance so that we can avoid further changes in the future.

jelbourn commented 5 years ago

@mmalerba do you have any input on this?

mmalerba commented 5 years ago

Yeah, we should update the docs to show outline or fill form-fields, unless the example is specifically trying to demonstrate something about one of the other appearances.

If people are looking to change the default in their app, they can do that with this injection token: https://github.com/angular/material2/blob/master/src/lib/form-field/form-field.ts#L93

mainawycliffe commented 5 years ago

@mmalerba if the other two appearances (legacy and standard) have been dropped shouldn't they be omitted from the documentation all together?

manklu commented 5 years ago

@mainawycliffe

I think unless they are deprecated and removed they should stay in the documentation.

Orodan commented 5 years ago

So is that the final decision to keep the "standard" and "legacy" style in the doc ? And if that's the case is there any point in keeping the issue open :) ?

Splaktar commented 4 years ago

@Orodan yes there is still a point as the examples need to be updated to use filled or outline by default. The legacy/standard should only be used in the section describing the 4 different appearances. Currently only the appearance example includes fill or outline appearances. All other examples use legacy and need to be updated to fill or outline.

@mmalerba what will be the default in the future (maybe v10?) fill?

mmalerba commented 4 years ago

I'm fine with either fill or outline being the new default. I don't think its important which one, but its nice to have the concept of a default since that can be overridden globally with a provider to change the whole app at once.

Splaktar commented 4 years ago
angular-automatic-lock-bot[bot] commented 4 years ago

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.