@synergy-design-system/angular
Version:
Angular wrappers for the Synergy Design System
68 lines (64 loc) • 3.33 kB
TypeScript
import * as i0 from '@angular/core';
import { ElementRef, NgZone } from '@angular/core';
import SynFieldset from '@synergy-design-system/components/components/fieldset/fieldset.component.js';
/**
* @summary Fieldsets are used to group related elements in a form.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-fieldset--docs
* @status stable
* @since 3.18.0
*
* @slot - The fieldset's main content. Place form controls inside the fieldset to group them together.
* @slot legend - Add a legend to the fieldset. This is displayed as the title of the fieldset. Alternatively, you can use the `legend` attribute.
* @slot description - Add a description to the fieldset. This is displayed below the legend and provides additional information about the fieldset. Alternatively, you can use the `description` attribute.
*
* @csspart base - The component's base wrapper.
* @csspart legend - The component's legend element.
* @csspart description - The component's description element.
* @csspart field-container - The container for the fieldset's fields.
*
* @cssproperty --item-gap - The gap between the fields in the fieldset. Defaults to `--syn-spacing-large`
*/
declare class SynFieldsetComponent {
nativeElement: SynFieldset;
private _ngZone;
constructor(e: ElementRef, ngZone: NgZone);
/**
* The description for the fieldset.
* This is displayed below the legend.
If not provided, the fieldset will not have a description.
*/
set description(v: SynFieldset['description']);
get description(): SynFieldset['description'];
/**
* The legend for the fieldset.
* This is displayed as the title of the fieldset.
If not provided, the fieldset will not have a legend.
*/
set legend(v: SynFieldset['legend']);
get legend(): SynFieldset['legend'];
/**
* Whether the fieldset is disabled.
When true, all form controls inside the fieldset are disabled
*/
set disabled(v: '' | SynFieldset['disabled']);
get disabled(): SynFieldset['disabled'];
/**
* Disables automatic grouped control layout syncing.
When true, nested grouped controls keep their own layout configuration.
*/
set disableAutoGroupLayout(v: '' | SynFieldset['disableAutoGroupLayout']);
get disableAutoGroupLayout(): SynFieldset['disableAutoGroupLayout'];
/**
* The layout of the fieldset.
* This determines how the fields are displayed.
Defaults to `one-column`.
- `one-column`: All fields are displayed in a single column.
- `two-columns`: Fields are displayed in two columns.
* Will automatically fall back to one-column if the fieldset is too narrow to display two columns.
*/
set layout(v: SynFieldset['layout']);
get layout(): SynFieldset['layout'];
static ɵfac: i0.ɵɵFactoryDeclaration<SynFieldsetComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SynFieldsetComponent, "syn-fieldset", never, { "description": { "alias": "description"; "required": false; }; "legend": { "alias": "legend"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "disableAutoGroupLayout": { "alias": "disableAutoGroupLayout"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; }, {}, never, ["*"], true, never>;
}
export { SynFieldsetComponent };