Skip to content

chore: add docs to undocumented form field symbols #11435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions src/lib/form-field/form-field.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,35 @@ const floatingLabelScale = 0.75;
const outlineGapPadding = 5;


// Boilerplate for applying mixins to MatFormField.
/** @docs-private */
/**
* Boilerplate for applying mixins to MatFormField.
* @docs-private
*/
export class MatFormFieldBase {
constructor(public _elementRef: ElementRef) { }
}


/**
* Base class to which we're applying the form field mixins.
* @docs-private
*/
export const _MatFormFieldMixinBase = mixinColor(MatFormFieldBase, 'primary');


/** Possible appearance styles for the form field. */
export type MatFormFieldAppearance = 'legacy' | 'standard' | 'fill' | 'outline';


/**
* Represents the default options form the form field that can be configured
* using the `MAT_FORM_FIELD_DEFAULT_OPTIONS` injection token.
*/
export interface MatFormFieldDefaultOptions {
appearance?: MatFormFieldAppearance;
}

/**
* Injection token that can be used to configure the
* default options for all form field within an app.
*/
export const MAT_FORM_FIELD_DEFAULT_OPTIONS =
new InjectionToken<MatFormFieldDefaultOptions>('MAT_FORM_FIELD_DEFAULT_OPTIONS');

Expand Down