chore(notched-outline): separate outline from text-field #2326
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <!--docs: | ||
| title: "Notched Outline" | ||
| layout: detail | ||
| section: components | ||
| excerpt: "The notched outline is a border around either a text field or select element" | ||
| iconId: text_field | ||
| path: /catalog/input-controls/notched-outline | ||
| --> | ||
|
|
||
| # Notched Outline | ||
|
|
||
| The outline is a border around all sides of either a text field or select component. This is used for the Outlined variant of either a Text Field or Select. | ||
|
|
||
| ## Design & API Documentation | ||
|
|
||
| <ul class="icon-list"> | ||
| <li class="icon-list-item icon-list-item--spec"> | ||
| <a href="https://material.io/guidelines/components/text-fields.html#text-fields-field-variations">Material Design guidelines: Text Field Variations</a> | ||
| </li> | ||
| </ul> | ||
|
|
||
| ## Usage | ||
|
|
||
| ### HTML Structure | ||
|
|
||
| ```html | ||
| <div class="mdc-notched-outline"> | ||
| <svg> | ||
| <path class="mdc-notched-outline__path"/> | ||
| </svg> | ||
| </div> | ||
| <div class="mdc-notched-outline__idle"></div> | ||
| ``` | ||
|
|
||
| > For usage within a text field [see](../mdc-textfield/README.md#outlined/). | ||
|
|
||
| ### CSS Classes | ||
|
|
||
| CSS Class | Description | ||
| --- | --- | ||
| `mdc-notched-outline` | Mandatory. Container for the SVG of the notched outline path. | ||
| `mdc-notched-outline__path` | Mandatory. The path of the SVG of the notched outline. | ||
| `mdc-notched-outline__idle` | Mandatory. The full outline when the notch is hidden. | ||
|
|
||
| ### Sass Mixins | ||
|
|
||
| Mixin | Description | ||
| --- | --- | ||
| `mdc-notched-outline-color($color)` | Customizes the border color of the notched outlined. | ||
| `mdc-notched-outline-idle-color($color)` | Customizes the border color of the idle outline. | ||
|
|
||
| ### `MDCNotchedOutline` | ||
|
|
||
| Method Signature | Description | ||
| --- | --- | ||
| `updateSvgPath(notchWidth: number, isRtl: boolean) => void` | Updates the SVG of the outline element with a notch calculated based off of the notchWidth. The notch will appear left justified, unless isRtl is true. | ||
|
|
||
| ### `MDCNotchedOutlineAdapter` | ||
|
|
||
| Method Signature | Description | ||
| --- | --- | ||
| `getWidth() => number` | Returns the width of the outline element. | ||
| `getHeight() => number` | Returns the height of the outline element. | ||
| `setOutlinePathAttr(value: string) => void` | Sets the "d" attribute of the outline element's SVG path. | ||
| `getIdleOutlineStyleValue(propertyName: string) => string` | Returns the idle outline element's computed style value of a given css `propertyName`. | ||
|
|
||
| ### `MDCNotchedOutlineFoundation` | ||
|
|
||
| Method Signature | Description | ||
| --- | --- | ||
| `updateSvgPath(notchWidth: number, isRtl: boolean) => void` | Updates the SVG path of the focus outline element based on the given notchWidth and the RTL context. | ||
|
|
||
|
|
||
| [//]: <> (TODO(mattgoo): add how to hide/show notch in outline) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // | ||
| // Copyright 2018 Google Inc. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| @import "@material/theme/mixins"; | ||
|
|
||
| @mixin mdc-notched-outline-idle-color($color) { | ||
| .mdc-notched-outline__idle { | ||
| @include mdc-theme-prop(border-color, $color); | ||
| } | ||
| } | ||
|
|
||
| @mixin mdc-notched-outline-color($color) { | ||
| .mdc-notched-outline__path { | ||
|
There was a problem hiding this comment. Add There was a problem hiding this comment. Do you think that the |
||
| @include mdc-theme-prop(stroke, $color); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing the word "here"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean it should be
text field see [here]?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, otherwise it would say "For usage within a text field see."