angular-package

The angular-package supports the development process of angular-based applications in varied ways through the thoughtful, reusable, easy-to-use small pieces of code called packages.

docs.angular-package.dev

Packages

| Package | Description | Status | | :------------------------------------------- | :---------------------------------------------------------------- | -----: | | callback | Manages the callback function. | | | change-detection | Improves application performance. | | | component-loader | Handles dynamic loading components. | | | core | Core features. | | | error | Manages an Error. | | | name | The name with prefix and suffix. | | | preferences | Preferences, settings, options, configuration and setup in steps. | | | prism | Prism highlighter module. | | | property | Handles object properties. | | | range | The range between a minimum and maximum. | | | reactive | Automatize the process of creating some rxjs features. | | | spectre.css | Modified Spectre.css - a lightweight, responsive, and modern CSS framework originally designed by Yan Zhu. | | | storage | The storage of data under allowed names. | | | tag | Any tag with optional attributes. | | | testing | Support for testing other packages. | | | text | Text on the template with replaceable tags. | | | type | Common types, type guards, and type checkers. | | | ui | Configurable user interface. | | | wrapper | Wrap the text with the opening and closing chars. | |

Click on the package name to visit its GitHub page.

angular-package/ui

Configurable user interface.

Documentation

~~For the detailed documentation go to https://ui.angular-package.dev~~

There is no documentation and demonstration available at the moment.

Table of contents

• Skeleton
• Installation
• Changelog
• Api
• Git
  • Commit
  • Versioning
• License

Skeleton

The package was generated by the library skeleton which was generated with Angular CLI version 13.0.0. Copy package to the packages/ui folder of the library skeleton then run the commands below.

Code scaffolding

Run ng generate component component-name --project ui to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project ui.

Note: Don't forget to add --project ui or else it will be added to the default project in your angular.json file.

Build

Run ng build ui to build the package. The build artifacts will be stored in the dist/ui directory.

Publishing

After building your library with ng build ui, go to the dist folder cd dist/ui and run npm publish.

Running unit tests

Before the test can be performed install @angular-package/testing and @angular-package/type with command:

npm i @angular-package/testing @angular-package/type --no-save

Run ng test ui to execute the unit tests via Karma.

Installation

Install @angular-package/ui package with command:

npm i @angular-package/ui --save

Api

/*
 * Public API Surface of ui
 */
import { Ability, AbilityService } from '@angular-package/ui';
import { Active, ActiveService } from '@angular-package/ui';
import { Align } from '@angular-package/ui';

import { BlurService } from '@angular-package/ui';
import { Boolean } from '@angular-package/ui';

// Color.
import {
  // Class.
  Color,
  CssPropertyColor,

  // Type.
  BgColors,
  Colors,
  Shade,

  // Constant.
  CSS_COLORS
} from '@angular-package/ui';

// Css property.
import { CssProperty } from '@angular-package/ui';

// Expandable.
import {
  Expandable,
  ExpandableService,
} from '@angular-package/ui';

// Main.
import {
  Duration,
  Status,
} from '@angular-package/ui';

// Margin.
import {
  // Class.
  Margin,
  MarginService,
} from '@angular-package/ui';

// Name.
import {
  // Class.
  Name,
  Prefix,
  Suffix,

  // Type.
  AffixedName,
  PrefixedName,
  SuffixedName,
} from '@angular-package/ui';

// Padding.
import { Padding } from '@angular-package/ui';

// Pattern.
import { Pattern } from '@angular-package/ui';

// Position.
import { Position } from '@angular-package/ui';

/*
 * Public API Surface of range
 */
import {
  // Abstract class.
  Inequality,

  // Class.
  Greater,
  Less,
  Maximum,
  Minimum,
  Number,
  Range,
} from '@angular-package/ui';

// Rxjs.
import {
  Subjects,
  Subscriptions,
} from '@angular-package/ui';

// Scale.
import {
  // Class.
  Scale,

  // Constant.
  AVAILABLE_LEVELS,

  // Type.
  Levels
} from '@angular-package/ui';

// Sidebar.
import {
  // Service.
  SidebarService,

  // Interface.
  SidebarConfig
} from '@angular-package/ui';

// Size.
import {
  Size,
  SizeService,

  // Interface.
  SizeOptions,

  // Type.
  Sizes,
  SizesConfig,
} from '@angular-package/ui';

// String.
import { String } from '@angular-package/ui';

// Text align.
import {
  // Class.
  TextAlign,

  // Type.
  TxtAlign
} from '@angular-package/ui';

// Type.
import {
  Presence,
  Shape,
  Subscribable,
  TransitionDuration
} from '@angular-package/ui';

Changelog

The changelog of this package is based on keep a changelog. To read it, click on the CHANGELOG.md link.

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. - keep a changelog

GIT

Commit

• AngularJS Git Commit Message Conventions
• Karma Git Commit Msg
• Conventional Commits

Versioning

Semantic Versioning 2.0.0

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

FAQ How should I deal with revisions in the 0.y.z initial development phase?

The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.

How do I know when to release 1.0.0?

If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.

License

MIT © angular-package (license)