\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Nathan (Nathane2005)} \pdfinfo{ /Title (angular-2-forms.pdf) /Creator (Cheatography) /Author (Nathan (Nathane2005)) /Subject (Angular 2 Forms Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{2A63A3} \definecolor{LightBackground}{HTML}{F1F5F9} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Angular 2 Forms Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Nathan (Nathane2005)} via \textcolor{DarkBackground}{\uline{cheatography.com/28056/cs/8477/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Nathan (Nathane2005) \\ \uline{cheatography.com/nathane2005} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 9th October, 2016.\\ Updated 9th October, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Introduction}} \tn \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{A form creates a cohesive, effective, and compelling data entry experience. An Angular form coordinates a set of data-bound user controls, tracks changes, validates input, and presents errors.% Row Count 4 (+ 4) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Form}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}form\textgreater{} \newline .... tags that include all input elements \newline \textless{}/form\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{All forms are placed within the HTML form tags} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.54287 cm} x{3.43413 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Standard Input Types}} \tn % Row 0 \SetRowColor{LightBackground} Text Input & \textless{}input type="text"\textgreater{} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Email Input & \textless{}input type="email"\textgreater{} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} Password Input & \textless{}input type="password"\textgreater{} \tn % Row Count 4 (+ 2) % Row 3 \SetRowColor{white} Dropdown Selection & \textless{}select\textgreater{} \{\{nl\}\} \textless{}option value="volvo"\textgreater{}Volvo\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="saab"\textgreater{}Saab\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="opel"\textgreater{}Opel\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="audi"\textgreater{}Audi\textless{}/option\textgreater{}\{\{nl\}\} \textless{}/select\textgreater{} \tn % Row Count 12 (+ 8) % Row 4 \SetRowColor{LightBackground} Multi Selection & \textless{}select multiple\textgreater{} \{\{nl\}\} \textless{}option value="volvo"\textgreater{}Volvo\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="saab"\textgreater{}Saab\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="opel"\textgreater{}Opel\textless{}/option\textgreater{} \{\{nl\}\} \textless{}option value="audi"\textgreater{}Audi\textless{}/option\textgreater{}\{\{nl\}\} \textless{}/select\textgreater{} \tn % Row Count 20 (+ 8) % Row 5 \SetRowColor{white} Checkbox & \textless{}input type="checkbox"\textgreater{} \tn % Row Count 21 (+ 1) % Row 6 \SetRowColor{LightBackground} Radio Control & \textless{}input type="radio"\textgreater{} \tn % Row Count 23 (+ 2) % Row 7 \SetRowColor{white} Numeric Input & \textless{}input type="number"\textgreater{} \tn % Row Count 25 (+ 2) % Row 8 \SetRowColor{LightBackground} Date & \textless{}input type="date"\textgreater{} \tn % Row Count 26 (+ 1) % Row 9 \SetRowColor{white} Multiline Input & \textless{}textarea rows="4" cols="50"\textgreater{}\textless{}/textarea\textgreater{} \tn % Row Count 28 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.09494 cm} x{3.88206 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Angular 2 Form - Elements}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{FormGroup} & A FormGroup aggregates the values of each child FormControl into one object, with each control name as the key \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} \seqsplit{FormControl} & Tracks the value and validation status of an individual form control. It is one of the three fundamental building blocks of Angular forms \tn % Row Count 9 (+ 5) % Row 2 \SetRowColor{LightBackground} \seqsplit{FormArray} & Tracks the value and validity state of an array of FormControl instances. A FormArray aggregates the values of each child FormControl into an array \tn % Row Count 14 (+ 5) % Row 3 \SetRowColor{white} \seqsplit{FormBuilder} & Creates an AbstractControl from a user-specified configuration. It is essentially syntactic sugar that shortens the new FormGroup(), new FormControl(), and new FormArray() boilerplate that can build up in larger form \tn % Row Count 21 (+ 7) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Requires use of FormModule} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.34379 cm} x{3.63321 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Reactive Form Names}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{formGroupName} & Used to reference a group of elements \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \seqsplit{formControlName} & Similar to ngModel reference to a name but simpler from a naming convention perspective \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} \seqsplit{formArrayName} & Syncs a nested FormArray to a DOM element. \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Requires the use of the ReactiveFormsModule Module} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Handling Submission Event}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}form (ngSubmit)="onSubmit()"\textgreater{} \newline ... \newline \textless{}/form\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.69218 cm} x{3.28482 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Standard Validation}} \tn % Row 0 \SetRowColor{LightBackground} Mandatory & Validators.required \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Minimum Length & \seqsplit{Validator.minLength(size)} \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} Maximum Length & \seqsplit{Validators.maxLength(size)} \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} Pattern Match & \seqsplit{Validators.pattern("regEx")} \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Custom Validators}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{function \{name\}(control : FormControl) : \{{[}s: string{]} : boolean\} \{ \newline \newline .... function body.... \newline \newline pass return a null \newline \newline fail return an object of type \{key : true\} \newline \newline \newline \}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Displaying Validator Failures}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}label for="name"\textgreater{}Name\textless{}/label\textgreater{} \newline \textless{}input type="text" class="form-control" id="name" \newline required \newline {[}(ngModel){]}="model.name" name="name" \newline \#name="ngModel" \textgreater{} \newline \textless{}div {[}hidden{]}="name.valid || name.pristine" \newline class="alert alert-danger"\textgreater{} \newline Name is required \newline \textless{}/div\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Workflow}} \tn \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Steps to creating a reactive form: \newline % Row Count 1 (+ 1) 1. Create the Domain Model \newline % Row Count 2 (+ 1) 2. Create the Controller with references to View \newline % Row Count 3 (+ 1) 3. Create the View \newline % Row Count 4 (+ 1) 4. Add Validations \newline % Row Count 5 (+ 1) 5. Add Submit Validation Control \newline % Row Count 6 (+ 1) 6. Add Dynamic Behaviors% Row Count 7 (+ 1) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Model}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{export interface \{ModelName\} \{ \newline \newline item(? : optional) : string | number | date | boolean | class | interface ({[}{]} : array); \newline \newline \newline \}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Controller}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{let style = \seqsplit{require('./someStyle.css');} \newline let template = \seqsplit{require("./someTemplate.html");} \newline \newline \newline @Component(\{ \newline \newline styles:{[}style{]}, \newline template: template \newline \newline \newline \}); \newline export class \{Some\}Form implements OnInit\{ \newline \newline myForm: FormGroup; \newline \newline constructor(private fb : FormBuilder) \{\}; \newline \newline ngOnInit() \{ \newline //Construct the form data type \newline \newline this.myForm: this.fb.group(\{ \newline 'controlName' : this.fb.control(...), \newline 'controlArray' : this.fb.array({[}...{]}), \newline 'controlGroup' : this.fb.group(\{\}) \newline \}); \newline \newline \} \newline \newline onSubmit() \{ \newline myForm.value; //returns the form values \newline \newline myModel = \textless{}MyModel\textgreater{}myForm.value;//Cast to object \newline \newline \newline \newline \} \newline \}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Typical additions include: \newline \newline 1. Http Service Submission (delegate normally injected) \newline 2. Pipes for Display customization \newline 3. Model based Validators} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{View}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}form {[}formGroup{]}='myForm' (ngSubmit)='onSubmit()'\textgreater{} \newline \newline \textless{}input formControlName=''\textgreater{} \newline \newline \textless{}div formGroupName=''\textgreater{} \newline \textless{}input formControlName=''\textgreater{} \newline \textless{}/div\textgreater{} \newline \textless{}div formArrayName=''\textgreater{} \newline \textless{}input formControlName='\{\{index\}\}' \newline *ngFor='let item of items; index = index'\textgreater{} \newline \textless{}/div\textgreater{} \newline \newline \textless{}/form\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Useful Blocks}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{-{}- Get Form Items \newline JSON.stringify(myForm.value)} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Useful Links}} \tn \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{\{\{link="https://angular.io/docs/ts/latest/guide/forms.html"\}\}Angular Forms\{\{/link\}\} \newline % Row Count 2 (+ 2) \{\{link="https://www.typescriptlang.org/docs/handbook/basic-types.html"\}\}TypeScript Basic Types\{\{/link\}\} \newline % Row Count 5 (+ 3) \{\{link="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"\}\}HTML Inputs\{\{/link\}\}% Row Count 7 (+ 2) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}