@limetech/mdc-p2-notched-outline
Advanced tools
Changelog
4.0.0 (2019-11-02)
overflow: visible to button. (#4973) (905e84e)checkbox: mdc-checkbox-ink-color mixin now only applies to enabled checkboxes
chips: Chips markup, adapters, foundations, and events have changed.
select: In MDCMenu and MDCMenuSurface, hoistMenuToBody adapter method removed. In MDCSelect, HTML structure changed: the select anchor is now wrapped in a parent element, and the anchor's sibling is the select menu. Support for native select removed. Support added for select with no label. MDCSelectAdapter methods removed: getValue, setValue, isMenuOpen, setSelectedIndex, checkValidity, setValid, toggleClassAtIndex. MDCSelectAdapter methods added: hasLabel, getSelectedMenuItem, setSelectedText, isSelectedTextFocused, get/setSelectedTextAttr, getAnchorElement, setMenuAnchorElement, setMenuAnchorCorner, setMenuWrapFocus, set/removeAttributeAtIndex, focusMenuItemAtIndex, getMenuItemValues, getMenuItemCount, getMenuItemCount, getMenuItemAttr, getMenuItemTextAtIndex, add/removeClassAtIndex. MDCSelectFoundation setValue method removed; getDisabled, handleMenuItemAction, getSelectedIndex, get/setRequired, init added.
radio: In Checkbox, Renamed sass variables $mdc-radio-touch-area => $mdc-radio-ripple-size & $mdc-radio-ui-size => $mdc-radio-icon-size to be consistent with checkbox. Also, removed $mdc-radio-ui-pct sass variable.
switch: Renames switch variables $mdc-switch-tap-target-size => $mdc-switch-ripple-size, removes $mdc-switch-tap-target-initial-position and $mdc-switch-native-control-width.
list: New adapter method listItemAtIndexHasClass
list: Renamed mixin mdc-list-item-shape-radius() => mdc-list-single-line-shape-radius()
linear-progress: MDCLinearProgressAdapter adapter has new forceLayout method
text-field: Removed sass variable in notched outline - $mdc-notched-outline-transition-duration.
mdc-fab: This changes the structure of the FAB element by moving the ripple from the outer element to an inner mdc-fab__ripple element.
OLD
<button class="mdc-fab" aria-label="Favorite">
<span class="mdc-fab__icon material-icons">favorite</span>
</button>
NEW
<button class="mdc-fab" aria-label="Favorite">
<div class="mdc-fab__ripple"></div>
<span class="mdc-fab__icon material-icons">favorite</span>
</button>
radio: Ripple has been moved to a child element. See readme for updates.
slider: remove adapter methods appendTrackMarkers, removeTrackMarkers , setLastTrackMarkersStyleProperty , and add adapter method setTrackMarkers.
button: This changes the structure of the button element by moving the ripple from the outer <button> element to an inner mdc-button__ripple element.
OLD
<button class="mdc-button">
<span class="mdc-button__label">Hello World</span>
</button>
NEW
<button class="mdc-button">
<div class="mdc-button__ripple"></div>
<span class="mdc-button__label">Hello World</span>
</button>
chips: MDCChipSetAdapter#removeChip has been replaced with MDCChipSetAdapter#removeChipAtIndex. MDCChipSetAdapter#setSelected has been replaced with MDCChipSetAdapter#selectChipAtIndex
density: Renamed sass mixins & variables in MDC Data Table - mdc-data-table-header-row-height => mdc-data-table-header-cell-height & mdc-data-table-row-height => mdc-data-table-cell-height. Also removed mdc-button--dense variant, use button's density mixin instead.
Readme
The notched 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.
npm install @limetech/mdc-p2-notched-outline
<div class="mdc-notched-outline">
<div class="mdc-notched-outline__leading"></div>
<div class="mdc-notched-outline__notch">
<label class="mdc-floating-label">Label</label>
</div>
<div class="mdc-notched-outline__trailing"></div>
</div>
Note that the MDC Floating Label component is placed inside the notch element when used together with MDC Notched Outline.
See the MDC Text Field and MDC Select documentation for information on using Notched Outline in the context of those components.
@import "@limetech/mdc-p2-notched-outline/mdc-notched-outline";
import {MDCNotchedOutline} from '@limetech/mdc-p2-notched-outline';
const notchedOutline = new MDCNotchedOutline(document.querySelector('.mdc-notched-outline'));
See Importing the JS component for more information on how to import JavaScript.
| CSS Class | Description |
|---|---|
mdc-notched-outline | Mandatory. Container for the outline's sides and notch. |
mdc-notched-outline--notched | Modifier class to open the notched outline. |
mdc-notched-outline--no-label | Modifier class to use when the floating label is empty or not used. |
mdc-notched-outline__leading | Mandatory. Element representing the leading side of the notched outline (before the notch). |
mdc-notched-outline__notch | Mandatory. Element representing the notch. |
mdc-notched-outline__trailing | Mandatory. Element representing the trailing side of the notched outline (after the notch). |
| Mixin | Description |
|---|---|
mdc-notched-outline-color($color) | Customizes the border color of the notched outline. |
mdc-notched-outline-stroke-width($width) | Changes notched outline width to a specified pixel value. |
mdc-notched-outline-shape-radius($radius, $rtl-reflexive) | Sets the rounded shape to notched outline element with given radius size. Set $rtl-reflexive to true to flip radius values in RTL context, defaults to false. |
mdc-notched-outline-floating-label-float-position($positionY, $positionX, $scale) | Sets the position and scale of the floating label inside the notched outline. |
MDCNotchedOutline Properties and Methods| Method Signature | Description |
|---|---|
notch(notchWidth: number) => void | Opens the notch with the specified width. |
closeNotch() => void | Closes the notch, rendering a full outline. |
If you are using a JavaScript framework, such as React or Angular, you can create a Notched Outline for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.
MDCNotchedOutlineAdapter| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the notched outline element. |
removeClass(className: string) => void | Removes a class from the notched outline element. |
setNotchWidthProperty(width: number) => void | Sets the width of the notch in pixels. |
removeNotchWidthProperty() => void | Removes the width property from the notch element. |
MDCNotchedOutlineFoundation| Method Signature | Description |
|---|---|
notch(notchWidth: number) => void | Adds the mdc-notched-outline--notched class and updates the notch element's style based on notchWidth. |
closeNotch() => void | Removes the mdc-notched-outline--notched class. |
FAQs
The Material Components for the web notched-outline component
The npm package @limetech/mdc-p2-notched-outline receives a total of 0 weekly downloads. As such, @limetech/mdc-p2-notched-outline popularity was classified as not popular.
We found that @limetech/mdc-p2-notched-outline demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.
Security News
The White House is addressing fragmented cybersecurity regulations as CISOs report spending up to 50% of their time on compliance, aiming to harmonize requirements and improve cybersecurity outcomes.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.