Skip to content

docs: long text #199

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: long text #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8207f2b
docs: long text
dstala Aug 1, 2025
48c3deb
docs: rich text
dstala Aug 1, 2025
6790ee5
docs: email, ph
dstala Aug 1, 2025
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
43 changes: 18 additions & 25 deletions content/docs/fields/field-types/text-based/email.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,24 @@ tags: ['Fields', 'Field types', 'Text based types', 'Email']
keywords: ['Fields', 'Field types', 'Text based types', 'Email', 'Create email field']
---

The **Email** field is a text-based field designed specifically to store email addresses. It is a specialized version of the `Single line text` field, offering:

`Email` field is text based field custom-built for storing E-mail IDs. It is a special type of `Single line text` field with
- Optional validation for Email ID
- Cell display as clickable link

## Create an `Email` field
1. Click on `+` icon to the right of `Fields header`
2. On the dropdown modal, enter the field name (Optional).
3. Select the field type as `Email` from the dropdown.
4. Enable validation by toggling the `Validate Email` checkbox (Optional).
5. Set default value for the field (Optional).
6. Click on `Save Field` button.

![image](/img/v2/fields/types/email.png)

<Callout type="note">
- Specify default value without quotes.
- Validation only ensures that the value entered is a valid email ID. It does not check if the email ID exists.
</Callout>

## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
- [URL](/docs/product-docs/fields/field-types/text-based/url)
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
- Optional validation to ensure proper email format
- Display of values as clickable **mailto:** links

## Create an email field

1. Click on the `+` icon next to the last field in your table.
2. Enter a name for the field.
3. Select `Email` from the list of field types.
4. Optionally, you can enable validation by toggling the `Validate email` checkbox.
5. Optionally, you can set a default value for the field & add a description.
6. Click on `Save field` to add the field to your table.

Refer here for generic guidelines on [creating a field](/docs/product-docs/fields#create-a-field).

<Callout type="note">Validation checks only the format of the email. It does not verify if the email address exists.</Callout>

---


47 changes: 26 additions & 21 deletions content/docs/fields/field-types/text-based/long-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,39 @@ keywords: ['Fields', 'Field types', 'Text based types', 'Long text', 'Create lon
---


`Long Text` field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.
The **Long Text** field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.

## Create a `Long Text` field
1. Click on `+` icon to the right of `Fields header`
2. On the dropdown modal, enter the field name (Optional).
3. Select the field type as `Long text` from the dropdown.
4. Set default value for the field (Optional).
5. Click on `Save Field` button.
<Callout type="warning">Limit: 100,000 characters</Callout>

![image](/img/v2/fields/types/longtext.png)
## Create a single line text field
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Create a single line text field
## Create a long text field


:::note
- Specify default value without quotes.
- Use `Enter` key to add new line.
:::
1. Click on the `+` icon next to the last field in your table.
2. Enter a name for the field.
3. Select `Long text` from the list of field types.
4. Optionally, you can set a default value for the field & add a description.
5. Click on `Save field` to add the field to your table.

Refer here for generic guidelines on [creating a field](/docs/product-docs/fields#create-a-field).

<Callout type="info">To add a new line while editing a cell, press **Shift + Enter**. When using the expanded modal, you can use either **Shift + Enter** or **Enter**.</Callout>

### Cell display
`Long Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.

![image](/img/v2/fields/long-text-expand.png)
![image](/img/v2/fields/long-text-expand-2.png)
The `Long Text` field appears as a single-line preview in the table view to maintain a compact layout. To view the full content, click the expand icon within the cell. Alternatively, use the keyboard shortcut **Shift + Space** to open the expanded modal view.

<div style={{ textAlign: 'center' }}>
<img src="/img/v2/fields/long-text-expand.png" alt="Long Text Expand Icon" />
<img src="/img/v2/fields/long-text-expand-2.png" alt="Expanded Modal View" />
</div>

To make quick edits, you can also select the cell and press **Enter** to edit the text inline.

<div style={{ textAlign: 'center', marginTop: '1rem' }}>
<img src="/img/v2/fields/long-text-expand-3.png" alt="Inline Edit for Long Text" />
</div>

## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
- [URL](/docs/product-docs/fields/field-types/text-based/url)
- [Email](/docs/product-docs/fields/field-types/text-based/email)
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
<Callout type="info">On both input methods — inline edit and expanded modal — you can use the drag handle at the bottom-right corner of the text area to resize it and better accommodate your content.</Callout>

For rich text editing capabilities, you can use the [Rich text](/docs/product-docs/fields/field-types/text-based/rich-text) field type instead.

---
39 changes: 15 additions & 24 deletions content/docs/fields/field-types/text-based/phonenumber.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,24 @@
---
title: 'Phone Number'
description: 'This article explains how to create & work with a Phone number field.'
tags: ['Fields', 'Field types', 'Text based types', 'Phone number']
keywords: ['Fields', 'Field types', 'Text based types', 'Phone number', 'Create phone number field']
description: 'This article explains how to create & work with a Phone Number field.'
tags: ['Fields', 'Field types', 'Text based types', 'Phone Number']
keywords: ['Fields', 'Field types', 'Text based types', 'Phone Number', 'Create phone field']
---

The **Phone Number** field is a text-based field designed specifically to store phone numbers. It is a specialized version of the `Single line text` field, offering:

`Phone number` field is text based field that allows you to store phone numbers. It also allows you to validate the phone number.
- Optional validation to ensure proper phone number format
- Display of values as clickable **tel:** links

## Create a `Phone number` field
1. Click on `+` icon to the right of `Fields header`
2. On the dropdown modal, enter the field name (Optional).
3. Select the field type as `Phonenumber` from the dropdown.
4. Enable validation by toggling the `Validate Phonenumber` checkbox (Optional).
5. Set default value for the field (Optional).
6. Click on `Save Field` button.
## Create a phone number field

![image](/img/v2/fields/types/phonenumber.png)

<Callout type="note">
- Specify default value without quotes.
- Validation only ensures that the value entered is a valid phone number. It does not check if the phone number exists.
</Callout>

## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
- [URL](/docs/product-docs/fields/field-types/text-based/url)
- [Email](/docs/product-docs/fields/field-types/text-based/email)
1. Click on the `+` icon next to the last field in your table.
2. Enter a name for the field.
3. Select `Phone Number` from the list of field types.
4. Optionally, you can enable validation by toggling the `Validate phone number` checkbox.
5. Optionally, you can set a default value for the field & add a description.
6. Click on `Save field` to add the field to your table.

Refer here for generic guidelines on [creating a field](/docs/product-docs/fields#create-a-field).

<Callout type="note">Validation when enabled checks only the format of the phone number. It does not verify if the number is reachable or in service.</Callout>
67 changes: 32 additions & 35 deletions content/docs/fields/field-types/text-based/rich-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,36 @@ tags: ['Fields', 'Field types', 'Text based types', 'Rich text']
keywords: ['Fields', 'Field types', 'Text based types', 'Rich text', 'Create rich text field']
---

**Rich Text** is a text-based field type that extends the capabilities of the **Long Text** field by allowing text formatting. It supports formatting options such as bold, italic, underline, strikethrough, horizontal rule, ordered and unordered lists, inline code, block quotes, and more—enabling better structure and emphasis in your content.

`Rich Text` field is text based field & is extension of `Long text` that allows you to add formatting to the text. You can add text formatting like bold, italic, underline, strikethrough, horizontal rule, ordered list, unordered list, code, quote, etc.
<Callout type="warning">Limit: 100,000 characters</Callout>

## Create a `Rich Text` field
1. Click on `+` icon to the right of `Fields header`
2. On the dropdown modal, enter the field name (Optional).
3. Select the field type as `Long text` from the dropdown.
4. Enable `Rich Text` toggle field.
5. Set default value for the field (Optional).
6. Click on `Save Field` button.
## Create a single line text field
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Create a single line text field
## Create a rich text field


![image](/img/v2/fields/types/richtext.png)
1. Click on the `+` icon next to the last field in your table.
2. Enter a name for the field.
3. Select `Long text` from the list of field types.
4. Toggle the `Enable rich text` option to enable rich text formatting.
5. Optionally, you can set a default value for the field & add a description.
6. Click on `Save field` to add the field to your table.

:::note
- Specify default value without quotes.
- Use `Enter` key to add new line.
:::
Refer here for generic guidelines on [creating a field](/docs/product-docs/fields#create-a-field).

<Callout type="info">Rich text editing is supported only via the expanded modal view. You can use either **Shift + Enter** or **Enter** to add a new line in the expanded modal.</Callout>

### Cell display
`Rich Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.

![image](/img/v2/fields/long-text-expand.png)
![image](/img/v2/fields/long-text-expand-2.png)
The `Rich Text` field appears as a single-line preview in the table view to maintain a compact layout. To view the full content, click the expand icon within the cell. Alternatively, use the keyboard shortcut **Shift + Space** to open the expanded modal view.

<div style={{ textAlign: 'center' }}>
<img src="/img/v2/fields/long-text-expand.png" alt="Long Text Expand Icon" />
<img src="/img/v2/fields/rich-text-expand.png" alt="Expanded Modal View" />
</div>

<Callout type="info">Use the drag handle at the bottom-right corner of the text area to resize it and better accommodate your content.</Callout>

## Formatting options
NocoDB supports markdown syntax for formatting the text. Following are the supported formatting options.
NocoDB supports Markdown syntax for formatting text. Below are the supported formatting options you can use inside the **Rich Text** field.

### Heading
To create a heading, prefix `#` symbol preceding your heading text. The number of # symbols employed will dictate the heading's hierarchy level and typeface size. Three levels of headings are supported.
Expand All @@ -47,12 +50,15 @@ To create a heading, prefix `#` symbol preceding your heading text. The number o
### Text formatting
You can emphasise text with bold, italic, strikethrough or underline formatting options. Table below shows syntax, keyboard shortcut, example & output for each formatting option.

| Style | Syntax | Keyboard shortcut | Example | Output |
| --- | --- | --- | --- | --- |
| Bold | `**bold text**` | `Ctrl/Cmd + B` | `**This is bold text**` | **This is bold text** |
| Italic | `*italicized text*` | `Ctrl/Cmd + I` | `*This is italicized text*` | *This is italicized text* |
| Strikethrough | `~~strikethrough text~~` | `Ctrl/Cmd + Shift + X` | `~~This is strikethrough text~~` | ~~This is strikethrough text~~ |
| Underline | | `Ctrl/Cmd + U` | `This is underlined text` | <u>This is underlined text</u> |


| Formatting (Shortcut) | Syntax | Output |
|----------------------------------------------|--------------------------|------------------------|
| Bold<br></br>`Ctrl/Cmd + B` | `**bold text**` | **bold text** |
| Italic<br></br>`Ctrl/Cmd + I` | `*italicized text*` | *italicized text* |
| Strikethrough<br></br>`Ctrl/Cmd + Shift + X` | `~~strikethrough text~~` | ~~strikethrough text~~ |
| Underline<br></br>`Ctrl/Cmd + U` | `<u>underlined text</u>` | <u>underlined text</u> |


### Quote block
You can quote text with a `>`
Expand Down Expand Up @@ -104,9 +110,8 @@ You can create unordered list by using `Bulleted list` menu option in the rich t
* Item 1
* Item 2

:::note
You can create nested lists by using `tab` key & `shift + tab` key to indent & outdent the list items.
:::
<Callout type="info">Create nested lists by using `tab` key & `shift + tab` key to indent & outdent the list items.</Callout>


### Numbered List
You can create ordered list by using `Numbered list` menu option in the rich text toolbar or by preceding the text with `1.` symbol.
Expand All @@ -126,12 +131,4 @@ You can create task lists by using `Task list` menu option in the rich text tool
- [ ] Item 1
- [x] Item 2


## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
- [URL](/docs/product-docs/fields/field-types/text-based/url)
- [Email](/docs/product-docs/fields/field-types/text-based/email)
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)


---
10 changes: 0 additions & 10 deletions content/docs/fields/field-types/text-based/single-line-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,3 @@ The **Single line text** field is used to store short, freeform text values. It
Refer here for generic guidelines on [creating a field](/docs/product-docs/fields#create-a-field).

<Callout type="info">Specify default value as is, without quotes</Callout>

## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
- [URL](/docs/product-docs/fields/field-types/text-based/url)
- [Email](/docs/product-docs/fields/field-types/text-based/email)
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)



8 changes: 0 additions & 8 deletions content/docs/fields/field-types/text-based/url.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ keywords: ['Fields', 'Field types', 'Text based types', 'URL', 'Create URL field
- Validation only ensures that the value entered is a valid URL. It does not check if the URL exists.
</Callout>

## Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
- [Email](/docs/product-docs/fields/field-types/text-based/email)
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)


Binary file modified public/img/v2/fields/long-text-expand-2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/img/v2/fields/long-text-expand-3.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/img/v2/fields/long-text-expand.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/img/v2/fields/rich-text-expand.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading