carbon-components-angular
Version:
Next generation components
68 lines (64 loc) • 2.76 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | checkbox-group.component.d.ts
*
* Copyright 2014, 2026 IBM
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AfterContentInit, ChangeDetectorRef, OnChanges, QueryList, SimpleChanges, TemplateRef } from "@angular/core";
import { Checkbox } from "./checkbox.component";
import * as i0 from "@angular/core";
/**
* Groups related checkboxes with a shared legend, validation, and optional decorator
* (e.g. AI label).
*
* ```html
* <cds-checkbox-group legend="Group label" [decorator]="decoratorTpl">
* <cds-checkbox>Option 1</cds-checkbox>
* </cds-checkbox-group>
* ```
*/
export declare class CheckboxGroup implements OnChanges, AfterContentInit {
private changeDetectorRef;
private static nextHelperId;
hostFormItem: boolean;
checkboxes: QueryList<Checkbox>;
readonly helperTextId: string;
legend: string | TemplateRef<any>;
/**
* Optional id for the `<legend>`; referenced by `fieldsetAriaLabelledby` when set.
*/
legendId: string;
/**
* Optional `aria-labelledby` for the `<fieldset>` when not using `legendId`.
*/
fieldsetAriaLabelledby: string;
orientation: "horizontal" | "vertical";
helperText: string | TemplateRef<any>;
invalid: boolean;
invalidText: string | TemplateRef<any>;
warn: boolean;
warnText: string | TemplateRef<any>;
readOnly: boolean;
/**
* Optional decorator (e.g. AI label) rendered in the legend.
*/
decorator: TemplateRef<any>;
constructor(changeDetectorRef: ChangeDetectorRef);
ngOnChanges(changes: SimpleChanges): void;
ngAfterContentInit(): void;
isTemplate(value: any): boolean;
private notifyCheckboxesHostStateChanged;
static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxGroup, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<CheckboxGroup, "cds-checkbox-group, ibm-checkbox-group", never, { "legend": "legend"; "legendId": "legendId"; "fieldsetAriaLabelledby": "fieldsetAriaLabelledby"; "orientation": "orientation"; "helperText": "helperText"; "invalid": "invalid"; "invalidText": "invalidText"; "warn": "warn"; "warnText": "warnText"; "readOnly": "readOnly"; "decorator": "decorator"; }, {}, ["checkboxes"], ["*"], false>;
}