🚨 Latest Research:Tanstack npm Packages Compromised in Ongoing Mini Shai-Hulud Supply-Chain Attack.Learn More →
Socket
Book a DemoSign in
Socket

@webapp-suite/elements.aside

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@webapp-suite/elements.aside

latest
Source
npmnpm
Version
0.10.1
Version published
Maintainers
1
Created
Source

webapp-suite

Elements - aside

Part of the reusable webapp-suite UI Components as Web Components. Demo

NPM Version Downloads per month Dependent packages

table { width:100%; }

➤ Properties

PropertyAttributeTypeDefaultDescription
dirdirStringltrDirection of the component 'rtl' or 'ltr'
titledata-titleString''Aside header title
visibledata-visibleBooleanfalseShow/hide aside
busydata-busyStringIf it exist as an attribute, the aside would show a spinner in it with the provided value of this attribute as the message of it
noCloseOnEscKeyno-close-on-esc-keyBooleanfalseDisable closing the aside with escape key
hasFoothasFootBooleanfalseINTERNAL
hasPlatformObjecthasPlatformObjectBooleanfalseINTERNAL

➤ Slots

NameDescription
noteUse this slot name on the `ts-note` in the aside
platform-objectThe section between aside header and content that platform object should be shown with different background color
mainMain content of the aside that doesn't fit into any other available slots
footerFooter content and action buttons goes. You should use the ts-button-group here.

➤ Events

NameDescription
open
close
opened
closed

➤ How to use it

  • Install the package of aside
$ npm i @webapp-suite/elements.aside --save
  • Import the component
import '@webapp-suite/elements.aside';

or

<script src="node_modules/@webapp-suite/elements.aside/lib/aside.umd.js"></script>
  • Use it like demo

  • Our components rely on having the Open Sans available, You can see the font-weight and font-style you need to load here, or you can just load it from our package (for now)

<link rel="stylesheet" href="node_modules/@webapp-suite/elements/src/fonts.css" />

➤ Polyfills

For supporting IE11 you need to add couple of things

  • Don't shim CSS Custom Properties in IE11
<!-- Place this in the <head>, before the Web Component polyfills are loaded -->
<script>
	if (!window.Promise) {
		window.ShadyCSS = { nativeCss: true };
	}
</script>
You have two options for polyfills library:
  • Installation
$ npm i @open-wc/polyfills-loader
  • Load it
import loadPolyfills from '@open-wc/polyfills-loader';

loadPolyfills().then(() => import('./my-app.js'));
  • Installation
$ npm i @webcomponents/webcomponentsjs --save
  • Enable ES5 class-less Custom Elements
<script src="/node_modules/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>
<script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js" defer></script>

➤ How to contribute

Thanks for your interest and help!

  • First thing you need to do is read this [Component Checklist] which contains lots of important information about what you need to consider when you are creating/changing components
General info

You can find some links to useful materials about what we are using and some tutorials and articles that can help you get started.

➤ Polyfill Limitations

You can see a list of limitations that we should watch out for, here

➤ License

  • You can always create forks on GitHub, submit Issues and Pull Requests.
  • You can only use webapp-suite Elements to make apps on a webapp-suite platform, e.g. webapp-suite.com.
  • You can fix a bug until the bugfix is deployed by webapp-suite.
  • You can host webapp-suite Elements yourself.
  • If you want to make a bigger change or just want to talk with us, reach out to our team here on GitHub.

You can read the full license agreement in the LICENSE.md.

FAQs

Package last updated on 01 Nov 2021

Did you know?

Socket

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.

Install

Related posts