From e1d846f8fb17d4a8d7aba4c180f541d81d852c6f Mon Sep 17 00:00:00 2001 From: Binal Gajjar Date: Tue, 2 Apr 2019 12:24:03 +0530 Subject: [PATCH] Revert "Initial commit for documentation (#844)" (#868) This reverts commit 6e85d590e60e4e83490a23514086e787a5ea0cd7. --- extensions/core/interfaces/README.md | 35 ------------------- .../core/interfaces/text-input/README.md | 26 -------------- 2 files changed, 61 deletions(-) delete mode 100644 extensions/core/interfaces/README.md delete mode 100644 extensions/core/interfaces/text-input/README.md diff --git a/extensions/core/interfaces/README.md b/extensions/core/interfaces/README.md deleted file mode 100644 index 58fb8a20d0..0000000000 --- a/extensions/core/interfaces/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interfaces - -Interfaces are the way of inputting, editing and viewing data. The most easy way to understand interface is a datepicker. It allows you to represent the date in specified format & you can validate the inputs. It renders the date in better way by providing a diffrent UI than just a normal text. -In Database terms, interface reprents the column's value. - -## 💡Interfaces allows you to: - -- Accept & View the data in diffrent formats i.e. Datepicker, Dropdown, Checkboxes. -- Define the possible choices. -- Do RegEx validation of data. -- Define the database schema. - -## ⚙️ Default Options - -Each interface inherits the below options(passed via `props` and imported via `mixin`) - -| Option | Type | Default | Desc | -| -------- | ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| name | `String` | | Represents the column name in database/collection. | -| value | | | Data stored at respective column. | -| type | `String` | | Allowed fieldtypes this interface supports. List of all the fieldtypes can be found [here](https://docs.directus.io/guides/field-types.html) | -| length | `[String,Number]` | | Database length for the column. | -| readonly | `Boolean` | `false` | If the interface is in "Edit" mode or "Display" Mode. | -| required | `Boolean` | `false` | If the value is reqired. | -| options | `Object` | `{}` | Interface specific options which are defined in `meta.json` are available under this. | -| newItem | `Boolean` | `false` | When creting a new item inside collection, this option is set to true for each interface. | -| relation | `Object` | | Defines the relation with other collections. | -| fields | `Object` | | Contains the list of other columns and its interface configuration from the same collection. | -| values | `Object` | | Contains the values of other columns from the same collection. | - - - -## ⚡ Enhancements - -- We can provide a prop named `savedValue` or similar which contains a value returned from an API, is immutable & changes only on successful crud. The `value` prop changes on user's interaction. Thus we can diffrentiate between server's state and user's state. diff --git a/extensions/core/interfaces/text-input/README.md b/extensions/core/interfaces/text-input/README.md deleted file mode 100644 index 23f4f57c7a..0000000000 --- a/extensions/core/interfaces/text-input/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: Text Input - -As the name suggests, it renders a normal text field with some additional options & formatting. - -## ⚙️ Options - -Checkout common interface options(passed via `props`) [here.](../README.md) - -| Option | Default | Interface | Desc | -| ------------------ | ------- | -------------- | --------------------------------------------------------------------- | -| placeholder | | [text-input]() | Placeholder Text. | -| trim | `true` | [toggle]() | Trims the blank space from the start & end of the text. | -| showCharacterCount | `true` | [toggle]() | Displays the number of characters written in textbox. | -| iconLeft | | [icon]() | Material Icon to display on the left side. | -| iconRight | | [icon]() | Material Icon to display on the right side. | -| formatValue | `false` | [toggle]() | Pretty output by converting the value to title case. | -| width | auto | [dropdown]() | Set textbox width. Available choices are "small", "medium" & "large". | - -## 🚧 Known Issues - -- `width` option not working. -- Can not remove icon once selected. The issue is with `icon` interface though. - -## ⚡ Enhancements - -- Masking support may be? or a new inteface for masking?