Core Components

screenshot of Core Components
react

Core Components

Alfa-Bank UI library

Overview

The document provides information about a product, including its features, installation guide, and development instructions. The product appears to be a library or framework for developing web components.

Features

  • Release Tests Coverage Status: Provides information about the coverage status of release tests.
  • Demo Build: Offers a demo build of the product for testing and demonstration purposes.
  • Commitizen Friendly: Supports the Commitizen tool for commit linting and generation of the CHANGELOG.MD file.
  • Storybook with Documentation and Sandbox: Includes a Storybook with documentation and a sandbox environment for easier component development and testing.
  • Theming: Provides a guide for theme customization and configuration.
  • Supported Browsers: Supports the latest stable versions of popular browsers, with exceptions for IE11+ and Android 5+ (Mobile Chrome).
  • Signatures of Callbacks: Explains the two arguments passed in callback functions: event (SyntheticEvent object) and payload (additional data object).
  • Importing Components within Components: Explains how to import and use components within other components in a monorepository setup.
  • Releases: Describes the commands and steps for releasing new versions, including beta releases.
  • Commits: Discusses commitlint setup, AngularJS commit conventions, and the use of commitizen for easier commit creation.
  • Component Builds: Provides import examples for different types of component builds: ES5, ES5 with CSS modules, and ES2020.
  • Contribution Guidelines: Encourages users to contribute to the product by submitting pull requests or issues.
  • Maintainers: Lists the maintainers of the product.

Installation

To install the product, follow these steps:

  1. Install all components: Each component is published as a separate package, so you can choose to install only the required components instead of the entire library.
  2. Usage: Instructions on how to use the product are not specified in the document.

Summary

The analyzed document provides information about a library or framework that includes features such as release tests coverage status, a demo build, Commitizen friendliness, a Storybook with documentation and a sandbox, theming, and more. The document also includes installation instructions and guidance for development, releases, commits, component builds, contribution guidelines, and the list of maintainers.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

rollup
Rollup

RollupJS is a popular and efficient JavaScript module bundler that takes the code from multiple modules and packages them into a single optimized file, minimizing the overall size of the application and improving its performance.

Stylelint

Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.