Skip to content

IgxChatOptions API page is empty (no properties or examples) despite being referenced in Chat docs #6321

@Zneeky

Description

@Zneeky

Description

In the Chat component documentation, the options input is described as:

options – Chat configuration (IgxChatOptions) such as current user ID, input placeholders, accepted file types, quick reply suggestions and typing behavior.

The link to IgxChatOptions works correctly and points to:
https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/types/igxchatoptions.html

However, the IgxChatOptions API page itself is essentially empty: it only shows the type alias header and the sentence:

Configuration options for the chat component.

There is no list of available properties, no descriptions and no usage examples, which is confusing because the Chat docs explicitly mention several options.

Image

Technical background

In the code, IgxChatOptions is defined as:

/**
 * Configuration options for the chat component.
 */
export type IgxChatOptions = Omit<IgcChatOptions, 'renderers'>;

And IgcChatOptions contains the actual shape of the options:

export type IgcChatOptions = {
    currentUserId?: string;
    disableAutoScroll?: boolean;
    disableInputAttachments?: boolean;
    isTyping?: boolean;
    acceptedFiles?: string;
    headerText?: string;
    inputPlaceholder?: string;
    suggestions?: string[];
    suggestionsPosition?: ChatSuggestionsPosition;
    stopTypingDelay?: number;
    adoptRootStyles?: boolean;
    renderers?: ChatRenderers;
}

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions