Gathering detailed insights and metrics for @advanced-rest-client/arc-overlay-mixin
Gathering detailed insights and metrics for @advanced-rest-client/arc-overlay-mixin
Gathering detailed insights and metrics for @advanced-rest-client/arc-overlay-mixin
Gathering detailed insights and metrics for @advanced-rest-client/arc-overlay-mixin
npm install @advanced-rest-client/arc-overlay-mixin
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
92 Commits
1 Watching
3 Branches
4 Contributors
Updated on 28 Jan 2023
JavaScript (100%)
Cumulative downloads
Total Downloads
Last day
-4.9%
328
Compared to previous day
Last week
-17.9%
1,422
Compared to previous week
Last month
-25.6%
6,066
Compared to previous month
Last year
-21.3%
86,559
Compared to previous year
5
Use the @anypoint-web-components/awc
module instead.
This mixin is a port of iron-overlay-behavior that works with LitElement.
Use ArcOverlayMixin
to implement an element that can be hidden
or shown, and displays on top of other content. It includes an optional
backdrop, and can be used to implement a variety of UI controls including
dialogs and drop downs. Multiple overlays may be displayed at once.
See the demo source code for an example.
1npm i @advanced-rest-client/arc-overlay-mixin
1import { LitElement } from 'lit-element'; 2import { ArcOverlayMixin } from '@advanced-rest-client/arc-overlay-mixin'; 3 4class ArcOverlayImpl extends ArcOverlayMixin(LitElement) { 5 static get properties() { 6 return { 7 myProp: { type: String } 8 }; 9 } 10}
An overlay may be hidden by closing or canceling. The difference between close
and cancel is user intent. Closing generally implies that the user
acknowledged the content on the overlay. By default, it will cancel whenever
the user taps outside it or presses the escape key. This behavior is
configurable with the nocancelonesckey
and the
nocancelonoutsideclick
properties. close()
should be called explicitly
by the implementer when the user interacts with a control in the overlay
element. When the dialog is canceled, the overlay fires an
'iron-overlay-canceled' event. Call preventDefault
on this event to prevent
the overlay from closing.
By default the element is sized and positioned to fit and centered inside the
window. You can position and size it manually using CSS. See ArcFitMixin
.
Set the withbackdrop
attribute to display a backdrop behind the overlay.
The backdrop is appended to <body>
and is of type <iron-overlay-backdrop>
.
See its doc page for styling options.
In addition, with-backdrop
will wrap the focus within the content in the
light DOM. Override the _focusableNodes
getter to achieve a different behavior.
The element is styled to appear on top of other content by setting its
z-index
property. You must ensure no element has a stacking context with a
higher z-index
than its parent stacking context. You should place this
element as a child of <body>
whenever possible.
1npm run test
1npm start
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
Reason
project is archived
Details
Reason
Found 2/25 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
19 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More