Skip to main content
Neural Nativev0.1.0-beta.1Documentation

Data & media

Avatar

Represent a person with a compact identity marker.

Angular NativeiOS / Android0.1.0-beta.1

Import

component.ts
import { NeuAvatarComponent } from '@neural-ui/native/avatar';

Examples

Import ExampleComponent into its parent and place <app-example /> inside your application’s root neu-theme. The preview supplies the device frame and safe areas; use the root setup from Installation in your app.

Team initials

Compose a studio directory with a compact team portrait and a readable roster. Large, medium and small initials keep the actual Avatar proportions; names, roles and written availability provide context without relying on color.

View and copy the complete example
team-initials.component.ts
import { Component } from '@angular/core';
import { NeuDividerComponent } from '@neural-ui/native/divider';
import { NeuAvatarComponent } from '@neural-ui/native/avatar';
import { View, Text, ScrollView } from '@ng-native/components';

@Component({
  selector: 'app-example',
  imports: [NeuDividerComponent, NeuAvatarComponent, View, Text, ScrollView],
  template: `
    <scroll-view class="product-scroll" keyboardShouldPersistTaps="handled" [showsVerticalScrollIndicator]="true"><view class="product-stack"><view class="product-section"><text class="product-title" accessibilityRole="header">People behind the work</text><text class="product-caption">A recognizable team, even without photos</text></view>
    <view class="studio-team-cover"><view class="product-row"><view class="product-copy"><text class="team-kicker">NEURAL / PEOPLE</text></view><text class="team-edition">Studio 03</text></view>
    <text class="team-title">Better, together.</text><text class="team-description">Three perspectives. One thoughtful release.</text>
    <view class="team-cover-footer"><view class="team-avatar-pill"><neu-avatar label="Ada Lovelace" size="lg" /><neu-avatar label="Grace Hopper" size="md" tone="success" /><neu-avatar label="Alan Turing" size="sm" tone="neutral" /></view><text class="team-cover-note">Product collective</text></view></view>
    <view class="team-roster"><text class="team-section-label">YOUR COLLABORATORS</text>
    <view class="product-row"><neu-avatar label="Ada Lovelace" size="lg" /><view class="product-copy"><text class="product-heading">Ada Lovelace</text><text class="product-caption">Workspace owner</text></view></view>
    <neu-divider /><view class="product-row"><neu-avatar label="Grace Hopper" size="md" tone="success" /><view class="product-copy"><text class="product-heading">Grace Hopper</text><text class="product-caption">Engineering · Available</text></view></view>
    <neu-divider /><view class="product-row"><neu-avatar label="Alan Turing" size="sm" tone="neutral" /><view class="product-copy"><text class="product-heading">Alan Turing</text><text class="product-caption">Research · Away</text></view></view></view></view></scroll-view>
  `,
  styles: `
.actions { gap: 12px; align-items: flex-start; } text { color: var(--neu-text, #172033); font-size: 16px; }

:host { flex: 1; flex-shrink: 1; min-height: 0; }
.product-scroll { flex: 1; flex-shrink: 1; height: 0px; min-height: 0; }
.product-stack { gap: 24px; padding-bottom: 20px; }
.product-section { gap: 12px; }
.product-row { flex-direction: row; align-items: center; gap: 12px; }
.product-copy { flex: 1; min-width: 0; gap: 4px; }
.product-title { color: var(--neu-text, #172033); font-size: 24px; line-height: 30px; font-weight: 600; }
.product-heading { color: var(--neu-text, #172033); font-size: 17px; line-height: 23px; font-weight: 600; }
.product-caption { color: var(--neu-muted, #596477); font-size: 14px; line-height: 20px; }
.product-actions { flex-direction: row; flex-wrap: wrap; align-items: center; gap: 8px; }
.product-surface { gap: 16px; padding: 16px; border-radius: 16px; background-color: var(--neu-surface, #ffffff); border-width: 1px; border-color: var(--neu-border, #a5afbf); }
.studio-team-cover { gap: 16px; padding: 22px; border-radius: 20px; background-color: #132e57; }
.team-kicker { color: #b9d6ff; font-size: 11px; line-height: 16px; font-weight: 600; letter-spacing: 1px; }
.team-edition { color: #d4e2f7; font-size: 12px; }
.team-title { color: #ffffff; font-size: 31px; line-height: 36px; font-weight: 600; }
.team-description { color: #d4e2f7; font-size: 15px; line-height: 22px; }
.team-cover-footer { gap: 12px; padding-top: 8px; }
.team-avatar-pill { flex-direction: row; align-items: center; gap: 10px; align-self: flex-start; padding: 10px; border-radius: 40px; background-color: #e9f1ff; --neu-surface: #e9f1ff; --neu-text: #132e57; }
.team-cover-note { color: #d4e2f7; font-size: 12px; line-height: 18px; }
.team-roster { gap: 16px; padding: 4px 2px; }
.team-section-label { color: var(--neu-muted, #596477); font-size: 11px; line-height: 16px; font-weight: 600; letter-spacing: 1px; }
  `,
})
export class ExampleComponent {

}

Semantic colors

Compare the six semantic colors supplied by the theme.

View and copy the complete example
semantic-colors.component.ts
import { Component } from '@angular/core';
import { NeuAvatarComponent } from '@neural-ui/native/avatar';
import { View, ScrollView } from '@ng-native/components';

@Component({
  selector: 'app-example',
  imports: [NeuAvatarComponent, View, ScrollView],
  template: `
    <scroll-view class="usage-scroll" keyboardShouldPersistTaps="handled"><view class="usage-stack">
    <view class="usage-section">
    <view class="usage-row"><neu-avatar label="Alex Morgan" tone="brand" size="md" />
    <neu-avatar label="Sam Rivera" tone="neutral" size="md" />
    <neu-avatar label="Casey Lee" tone="success" size="md" />
    <neu-avatar label="Robin Bell" tone="info" size="md" />
    <neu-avatar label="Jamie Fox" tone="warning" size="md" />
    <neu-avatar label="Taylor Reed" tone="danger" size="md" /></view>
    </view>
    </view></scroll-view>
  `,
  styles: `
.actions { gap: 12px; align-items: flex-start; } text { color: var(--neu-text, #172033); font-size: 16px; }

.usage-scroll { flex: 1; }
.usage-stack { gap: 20px; padding-bottom: 20px; }
.usage-section { gap: 12px; }
.usage-heading { color: var(--neu-text, #172033); font-size: 16px; font-weight: 600; }
.usage-caption { color: var(--neu-muted, #64748b); font-size: 14px; }
.usage-row { flex-direction: row; flex-wrap: wrap; gap: 12px; align-items: center; }
.usage-actions { flex-direction: row; flex-wrap: wrap; gap: 8px; align-items: center; }


  `,
})
export class ExampleComponent {

}
Interactive playground

Change the settings and try the result.

Device captures shown in English.

Avatar · android · native capture
AndroidNative screenshot
Avatar · ios · native capture
iOSNative screenshot

API reference

Inputs

NameTypeDefaultBindingDescription
labelstringRequiredInputHuman-readable name for the control, action or group.
uristring''InputURI of the image or media asset to display; provide a supported native source.
toneNeuTone'brand'InputSemantic color: neutral, brand, success, info, warning or danger. The accent value remains a compatible alias for brand. Colors use NeuTheme tokens; explain statuses with words as well as color.
sizeNeuSize'lg'InputAvatar diameter: sm = 32, md = 40, lg = 48 points; initials use 12, 14 and 16 points. Avatar defaults to lg; AvatarGroup defaults to md and adds a 2-point separation ring.

Models

This component declares no two-way models.

Outputs

This component declares no public outputs.

Types and data interfaces

Use the imports in your application. The definitions below are provided for reference.

NeuTone

NeuTone.ts
import type { NeuTone } from '@neural-ui/native/foundation';

// Public definition for reference only. Import this type; do not redeclare it.
export type NeuTone = 'neutral' | 'brand' | 'accent' | 'success' | 'info' | 'warning' | 'danger';

NeuSize

NeuSize.ts
import type { NeuSize } from '@neural-ui/native/foundation';

// Public definition for reference only. Import this type; do not redeclare it.
export type NeuSize = 'sm' | 'md' | 'lg';