# @fundamental-ngx/core

[![npm version](https://badge.fury.io/js/%40fundamental-ngx%2Fcore.svg)](//www.npmjs.com/package/@fundamental-ngx/core)
![Build Status](https://github.com/SAP/fundamental-ngx/actions/workflows/create-release.yml/badge.svg?branch=main)
![npm](https://img.shields.io/npm/dm/@fundamental-ngx/core?label=npm%20downloads)
[![Slack](https://img.shields.io/badge/slack-ui--fundamentals-blue.svg?logo=slack)](https://ui-fundamentals.slack.com)
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/fundamental-ngx)](https://api.reuse.software/info/github.com/SAP/fundamental-ngx)

## Description

`@fundamental-ngx/core` is a set of Angular components built on the SAP Design System. It provides base UI components (button, dialog, card, calendar, table, etc.) that can be customized directly in templates.

See the [Component Documentation](https://sap.github.io/fundamental-ngx) for examples and API details.

## Requirements

Angular 21 or newer. Prior knowledge of Angular is recommended.

## Getting Started

```bash
ng add @fundamental-ngx/core
```

Import individual components (standalone by default):

```typescript
import { ButtonComponent } from '@fundamental-ngx/core/button';
import { DialogModule } from '@fundamental-ngx/core/dialog';
```

## Versioning

Check the [Breaking Changes](https://github.com/SAP/fundamental-ngx/wiki#breaking-changes) for upgrade guidance.

## Known Issues

See [Issues](https://github.com/SAP/fundamental-ngx/issues).

## Support

If you encounter an issue, you can [create a ticket](https://github.com/SAP/fundamental-ngx/issues).

## Contributing

See [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) for guidelines and [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) for building new components.

## License

See [LICENSE.txt](https://github.com/SAP/fundamental-ngx/blob/main/LICENSE.txt).
