Skip to main content

Angular

Angular uses CareOS through custom elements: every component is also registered as a <co-*> tag (Button is <co-button>, PatientBanner is <co-patient-banner>). They are the same components as the React package, so behaviour, accessibility and styling are identical. The elements render with React internally (installed as a peer dependency); your Angular code never touches React.

1. Install​

npm install health-components react react-dom

2. Register the elements once​

src/main.ts
import { bootstrapApplication } from '@angular/platform-browser';
import { defineCareOSElements } from 'health-components/elements';
import { AppComponent } from './app/app.component';

defineCareOSElements(); // registers every <co-*> element and injects the token stylesheet

bootstrapApplication(AppComponent);

Register only what you use with defineCareOSElements({ only: ['co-button', 'co-patient-banner'] }).

In angular.json, add the fonts (optional) and allow React's CommonJS modules so the build stays warning-free:

"options": {
"styles": ["node_modules/health-components/dist/fonts.css", "src/styles.css"],
"allowedCommonJsDependencies": ["react", "react-dom", "react-dom/client", "react/jsx-runtime", "scheduler"]
}

A complete, working app is in examples/angular.

3. Allow custom elements in your components​

src/app/app.component.ts
import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';

@Component({
selector: 'app-root',
standalone: true,
schemas: [CUSTOM_ELEMENTS_SCHEMA],
templateUrl: './app.component.html',
})
export class AppComponent {
allergies = ['Penicillin', 'Sulfa'];
claimActions = [{ label: 'Submit and Print CMS-1500' }, { label: 'Save as Draft' }];

submit() {
/* ... */
}
onAction(item: { label: string }) {
console.log('Picked', item.label);
}
}

For NgModule apps, add schemas: [CUSTOM_ELEMENTS_SCHEMA] to the module instead.

4. Use them in templates​

src/app/app.component.html
<div data-co-theme="classic" class="co-root">
<co-patient-banner name="Henna West" sex="F" age="38" dob="03/14/1988" mrn="MRN-100231" [allergies]="allergies">
</co-patient-banner>

<co-button variant="primary" icon-left="plus" (click)="submit()">Start Visit Note</co-button>

<co-split-button label="Submit Claim" [items]="claimActions" (co-item-select)="onAction($event.detail[0])">
</co-split-button>
</div>

How bindings map​

ReactCustom elementAngular
String, number or boolean prop iconLeft="plus"attribute icon-left="plus" or property iconLefticon-left="plus" or [iconLeft]="icon"
Array or object prop items={[...]}property items (or a JSON attribute)[items]="items"
Callback onChange(value)event co-change, value in event.detail(co-change)="save($event.detail)"
Callback with several arguments onSort(key, dir)event.detail is [key, dir](co-sort)="sort($event.detail)"
childrendefault slot (the element's content)<co-card>...</co-card>
Other content props, for example footernamed slot<div slot="footer">...</div>
Render functions, for example a column renderproperty only[columns]="columns" with functions inside

Native events that cross shadow DOM (click, input, keydown, focusin) reach the host element as usual, so (click) works on <co-button>. A native change does not cross shadow DOM, so form controls send co-change instead, with the control's value (or checked for a checkbox) in event.detail.

Each component page lists its tag, attributes, properties, events and slots under Angular, Vue and HTML.

Forms​

Elements are not ControlValueAccessors. Bind the value and listen to the change event:

<co-text-field label="Mobile Phone" mask="phone" [value]="phone" (co-change)="phone = $event.detail"></co-text-field>

Theming​

Set data-co-theme on any ancestor, <html> included: classic, sidebar, rail, command or dark. The tokens are CSS variables and inherit into every element. Switching the attribute at runtime re-themes everything without a re-render.

TypeScript​

health-components/elements declares every tag in HTMLElementTagNameMap, so document.querySelector('co-button') is typed as CoButtonElement with its properties.

Styling and layout​

The elements render in shadow DOM with the CareOS stylesheet adopted, so your global CSS does not leak in and theirs does not leak out. The host element is display: contents, so it lays out like the component inside it. Content you put in a slot is styled by your own CSS.