1.0.0 • Published 11 months ago

@openscd/oscd-action-icon v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
11 months ago

\

This webcomponent follows the open-wc recommendation.

Installation

npm i @openscd/oscd-action-icon

Usage

<script type="module">
  import '@openscd/oscd-action-icon';
</script>

<oscd-action-icon></oscd-action-icon>

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode run:

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Icon font

Material Icons are being used for the icons. This font needs to be added in the html first. You can add it like so:

<link
  href="https://fonts.googleapis.com/css?family=Material+Icons&display=block"
  rel="stylesheet"
/>

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html

src/OscdActionIcon.ts:

Exports

KindNameDeclarationModulePackage
custom-element-definitionoscd-action-iconOscdActionIcon/src/oscd-action-icon.js
jsOscdActionIconOscdActionIconsrc/OscdActionIcon.ts

src/oscd-action-icon.ts:

class: OscdActionIcon, oscd-action-icon

Superclass

NameModulePackage
LitElementlit

Fields

NamePrivacyTypeDefaultDescriptionInherited From
labelstring \| undefinedcaption text, displayed in the header
iconstring \| undefinedicon name, displayed unless the "icon" slot is filled
secondarybooleanfalsecolor header with secondary theme color while focus is within
highlightedbooleanfalsehighlight pane with dotted outline
hideActionsbooleanfalsedisables CSS adoption to action buttons

CSS Properties

NameDefaultDescription
--oscd-action-icon-theme-primary--oscd-theme-primaryBorder and hover color.
--oscd-action-icon-theme-on-primary--oscd-theme-on-primaryFont color inside hover field.
--oscd-action-icon-theme-secondary--oscd-theme-secondarySecondary border and hover color.
--oscd-action-icon-theme-on-surface--oscd-theme-on-surfaceIcon and label color.
--oscd-action-icon-theme-font--oscd-theme-fontFont for label and hover text.

Slots

NameDescription
actionMay contain up to eight icon buttons.
iconIf filled overrides the icon property.
The default slot will be rendered into the pane body in a single column.

Exports

KindNameDeclarationModulePackage
jsOscdActionIconOscdActionIconsrc/oscd-action-icon.ts

© 2023 Alliander N.V.

@material/mwc-iconlitlit-elementlit-html
@everything-registry/sub-chunk-690
1.0.0

11 months ago