From c4929763ba22ae81cea1a50747e54d624c284817 Mon Sep 17 00:00:00 2001
From: Jenn Medellin <54321jenn@gmail.com>
Date: Tue, 16 Jan 2018 15:12:06 -0800
Subject: [PATCH] feat(docs): change file-input API from tables to lists in
README (#1082)
* feat(file-input): change API from tables to lists
* feat(file-input): change API from tables to lists
* feat(file-input): change API from tables to lists
---
src/platform/core/file/file-input/README.md | 63 ++++++++++++++-------
1 file changed, 41 insertions(+), 22 deletions(-)
diff --git a/src/platform/core/file/file-input/README.md b/src/platform/core/file/file-input/README.md
index 068a65763c..ff9ea50989 100644
--- a/src/platform/core/file/file-input/README.md
+++ b/src/platform/core/file/file-input/README.md
@@ -33,16 +33,27 @@ export class Demo {
## API Summary
-Properties:
+#### Inputs
-| Name | Type | Description |
-| --- | --- | 650--- |
-| color | string | Sets button color. Uses same color palette accepted as [MatButton].
-| multiple | boolean | Sets if multiple files can be dropped/selected at once in [TdFileUploadComponent].
-| accept | string | Sets files accepted when opening the file browser dialog. Same as "accept" attribute in `` element.
-| disabled | boolean | Disables [TdFileUploadComponent] and clears selected/dropped files.
-| select | function($event) | Event emitted when a file is selected. Emits a [File or FileList] object.
-| clear | function() | Used to clear the selected files from the [TdFileInputComponent].
++ color: string
+ + Sets button color. Uses same color palette accepted as [MatButton].
++ multiple: boolean
+ + Sets if multiple files can be dropped/selected at once in [TdFileUploadComponent].
++ accept: string
+ + Sets files accepted when opening the file browser dialog. Same as "accept" attribute in `` element.
++ disabled: boolean
+ + Disables [TdFileUploadComponent] and clears selected/dropped files.
+
+#### Events
+
++ select: function($event)
+ + Event emitted when a file is selected.
+ + Emits a [File or FileList] object.
+
+#### Methods
+
++ clear: function
+ + Used to clear the selected files from the [TdFileInputComponent].
## Setup
@@ -78,14 +89,17 @@ Example for usage:
## API Summary
-Properties:
+#### Inputs
-| Name | Type | Description |
-| --- | --- | 650--- |
-| multiple | boolean | Sets whether multiple files can be selected at once in host element, or just a single file. Can also be "multiple" native attribute.
-| fileSelect | function($event) | Event emitted when a file or files are selected in host [HTMLInputElement]. Emits a [FileList or File] object. Alternative to not use [(ngModel)].
++ multiple: boolean
+ + Sets whether multiple files can be selected at once in host element, or just a single file.
+ + Can also be "multiple" native attribute.
----
+#### Events
+
++ fileSelect: function($event)
+ + Event emitted when a file or files are selected in host [HTMLInputElement].
+ + Emits a [FileList or File] object. Alternative to not use [(ngModel)].
## TdFileDropDirective: tdFileDrop
@@ -107,13 +121,18 @@ Example for usage:
## API Summary
-Properties:
+#### Inputs
-| Name | Type | Description |
-| --- | --- | 650--- |
-| multiple | boolean | Sets whether multiple files can be dropped at once in host element, or just a single file. Can also be "multiple" native attribute.
-| disabled | boolean | Disabled drop events for host element.
-| fileDrop | function($event) | Event emitted when a file or files are dropped in host element after being validated. Emits a [FileList or File] object.
++ multiple: boolean
+ + Sets whether multiple files can be dropped at once in host element, or just a single file.
+ + Can also be "multiple" native attribute.
++ disabled: boolean
+ + Disabled drop events for host element.
+#### Events
----
++ fileDrop: function($event)
+ + Event emitted when a file or files are dropped in host element after being validated.
+ + Emits a [FileList or File] object.
+
+