@knora/action

Knora ui module: action

Stats

StarsIssuesVersionUpdatedCreatedSize
@knora/action
66810.0.12 years ago3 years agoMinified + gzip package size for @knora/action in KB

Readme

Knora-ui action module

npm (scoped)

This module is part of Knora-ui modules, developed by the team at the Data and Service Center for Humanities DaSCH.

The action module contains special pipes to sort lists or to get the index key in arrays, but also directives for images, sort buttons and s.o.

Prerequisites

For help getting started with a new Angular app, check out the Angular CLI.

For existing apps, follow these steps to begin using Knora-ui action.

Install

You can use either the npm or yarn command-line tool to install packages. Use whichever is appropriate for your project in the examples below.

Yarn

yarn add @knora/action

NPM

npm install --save @knora/action

Dependencies

This module has the following package dependencies, which you also have to install.

Required version of Knora: 12.0.0

Setup

Import the action module in your app.module.ts and add it to the NgModules's imports:

import { AppComponent } from './app.component';
import { KuiActionModule } from '@knora/action';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        KuiActionModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule {
}

Some components need a global styling in the app to override some material styling rules. Please update your angular.json file as follow:

...
    "styles": [
        "src/styles.scss",
        "node_modules/@knora/action/assets/style/action.scss" // <- add this line
    ],
...

Components, Directives and Pipes

This module contains various components like a progress indicator, sort button and sort-by pipe, but also helper for images (in the admin interface) and existing names.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.