@sinequa/atomic-angular

A modern, modular Angular library for building Search-Based Applications (SBA) with the Sinequa platform.

🚀 Overview

@sinequa/atomic-angular provides a rich set of Angular components, services, stores, and utilities to rapidly build advanced search and analytics applications. It is part of the Sinequa platform, offering enterprise-grade search, analytics, and AI capabilities.

• Modern UI components for search, navigation, metadata, and more
• State management with stores for user settings, themes, aggregations, and queries
• Powerful services for audit, preview, navigation, and backend integration
• Extensible utilities for queries, debounced signals, and more

📦 Installation

npm install @sinequa/atomic-angular

🛠️ Quick Start

1. Bootstrap your Angular app (Angular 20+):

   In your main.ts:

   import { bootstrapApplication } from '@angular/platform-browser';
   import { provideRouter } from '@angular/router';
   import { AppComponent } from './app/app.component';
   import { routes } from './app/app.routes';
   import { provideHttpClient } from '@angular/common/http';
   // Import any Sinequa providers if needed
   
   bootstrapApplication(AppComponent, {
     providers: [
       provideRouter(routes),
       provideHttpClient(),
       // ...other providers (e.g. Sinequa stores/services)
     ]
   });

2. Use Sinequa standalone components directly:

   In your app.component.ts (or any feature component):

   import { FiltersBarComponent, AggregationComponent, MoreComponent } from '@sinequa/atomic-angular';
   
   @Component({
     selector: 'app-root',
     standalone: true,
     imports: [FiltersBarComponent, AggregationComponent, MoreComponent],
     template: `
       <FiltersBar />
       <More />
       <Aggregation [name]="aggregationName" [column]="aggregationColumn" />
     `
   })
   export class AppComponent {
     aggregationName = 'Places';
     aggregationColumn = 'location';
   }

✨ Features

Components

• Metadata: Dynamic metadata display
• NavbarTabs: Tab navigation component for switching between views
• Aggregation: Faceted filter component for search and aggregation
• ...and more (see all components)

Services

• AuditService: Audit events (login, logout, document, route)
• PreviewService: Document preview with highlights/entities
• TextChunkService: Retrieve text chunks from backend
• JsonMethodPluginService: Call JSON plugins via HTTP
• NavigationService: Navigation and URL info
• SelectionService: Manage article selection
• ApplicationService: User auth, app init, dynamic routes
• ...(see all services)

Stores

• AppStore: App state, customization, computed values
• UserSettingsStore: Language, theme, bookmarks, recent searches
• ThemeStore: Theme settings, CSS variables
• AggregationsStore: Aggregation state
• SelectionStore: Article selection
• QueryParamsStore: Query parameters
• ...(see all stores)

Directives

• Custom Angular directives for enhanced HTML/component behavior (see all directives)

Guards

• Route guards for authentication, roles, and more (see all guards)

Interceptors

• HTTP interceptors for auth, audit, error handling (see all interceptors)

Pipes

• Custom pipes for formatting, highlighting, icons, and more (see all pipes)

Utilities

• Query utilities, debounced signals, and more (see all utilities)

Web Services

• Backend API integration for CRUD and more (see all web services)

📚 Documentation

• Full Documentation & Examples

📄 License

MIT

© Sinequa. Built with ❤️ for the Angular community.