From fc26fb241e5a2c18715ff76def5b10c9c93dfe07 Mon Sep 17 00:00:00 2001 From: Dominic Go <18517029+dominicstop@users.noreply.github.com> Date: Fri, 1 Jul 2022 10:06:35 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Docs:=20Update=20README=20-=20Cl?= =?UTF-8?q?eanup=20TOC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4c66ee2..a747911 100644 --- a/README.md +++ b/README.md @@ -50,17 +50,14 @@ | Sections and Links | | ------------------------------------------------------------ | -|
• [abc](#abc) | -|
--• [abc](#abc) | -|
----• [abc](#abc) | | [A. **Introduction**](#a-introduction)

• [Gifs and Demos](#gifs-and-demos)
• [Features](#features) | | [B. **Installation**](#b-installation)

• [Expo](#expo)
• [Troubleshooting](#troubleshooting)
--• [Xcode Build Error (Swift)](#troubleshooting-xcode-build-error-(swift))
--• [Xcode Build Error (Undefined symbol)](#troubleshooting-xcode-build-error-(undefined-symbol)) | | [C. **Basic Usage**](#c-basic-usage) | | [D. **Documentation**](#d-documentation)

• [D.1. Components](#d1-components)
--• [`ContextMenuView` Component](#contextmenuview-component)
----• [Props](#contextmenuview-component-props)
----• [Event Props](#contextmenuview-component-event-props)
----• [Properties/Methods](#contextmenuview-component-properties/methods)
----• [Experimental - Aux. Preview](#contextmenuview-component-experimental---auxiliary-preview)

--• [`ContextMenuButton` Component](#contextmenubutton-component)
----• [Props](#contextmenubutton-component-props)
----• [Event Props](#contextmenubutton-component-event-props)
----• [Properties/Methods](#contextmenubutton-component-properties/methods)

• [D.2. Context](#d2-context)
--• [`ContextMenuButtonContext`](#ContextMenuButtonContext-context)
--• [`ContextMenuButtonContext`](#ContextMenuButtonContext-context)

• [D.3. Hooks](#d3-hooks)
--• [`useMenuContext`](#useMenuContext-hook)
--• [`useMenuButtonContext`](#useMenuButtonContext-hook)

• [D.4. Objects and Types](#d4-objects-and-types)
--• [`MenuConfig.ts`](#MenuConfigts)
----• [Object Type: `MenuConfig`](#Object-Type-MenuConfig)
----• [Object Type: `MenuActionConfig`](#Object-Type-MenuActionConfig)
----• [Object Type: `DeferredMenuElementConfig`](#Object-Type-DeferredMenuElementConfig)
----• [String Union: `MenuAttributes`](#String-Union-MenuAttributes)
----• [String Union: `MenuState`](#String-Union-MenuState)
----• [String Union: `UIMenuOptions`](#String-Union-UIMenuOptions)

--• [`MenuPreviewConfig.ts`](#MenuPreviewConfigts)
----• [Object Type: `MenuPreviewConfig`](#Object-Type-MenuPreviewConfig)
----• [String Union: `ContextMenuInteractionCommitStyle`](#String-Union-ContextMenuInteractionCommitStyle)
----• [String Union: `MenuPreviewSize`](#String-Union-MenuPreviewSize)
----• [String Union: `MenuPreviewType`](#String-Union-MenuPreviewType)

--• [`MenuAuxiliaryPreviewConfig.ts`](#MenuAuxiliaryPreviewConfigts)
----• [Object Type: `MenuAuxiliaryPreviewConfig`](#Object-Type-MenuAuxiliaryPreviewConfig)
----• [String Union Type: `MenuAuxiliaryPreviewAnchorPosition`](#String-Union-Type-MenuAuxiliaryPreviewAnchorPosition)
----• [String Union Type: `MenuAuxiliaryPreviewHorizontalAlignment`](#String-Union-Type-MenuAuxiliaryPreviewHorizontalAlignment)
----• [String Union Type: `UIViewAnimateOptions`](#String-Union-Type-UIViewAnimateOptions)
----• [Object Type: `UIViewAnimateConfig`](#Object-Type-UIViewAnimateConfig)
----• [Object Type: `MenuAuxiliaryPreviewBaseTransitionConfig`](#Object-Type-MenuAuxiliaryPreviewBaseTransitionConfig)
----• [Object Union Type: `MenuAuxiliaryPreviewTransitionConfig`](#Object-Union-Type-`MenuAuxiliaryPreviewTransitionConfig`)
----• [Mixed Union Type: `MenuAuxiliaryPreviewTransitionEntranceDelay`](#Mixed-Union-Type-MenuAuxiliaryPreviewTransitionEntranceDelay)

--• [`MenuIconConfig.ts`](#MenuIconConfigts)
--• [`ImageItemConfig.ts`](#ImageItemConfigts)
----• [Object Type: `ImageItemConfig`](#Object-Type-ImageItemConfig)
----• [Object Type: `ImageResolvedAssetSource`](#Object-Type-ImageResolvedAssetSource)
----• [Object Type: `ImageRectConfig`](#Object-Type-ImageRectConfig)
----• [Object Type: `ImageGradientConfig`](#Object-Type-ImageGradientConfig)
----• [Object Type: `ImageSystemConfig`](#Object-Type-ImageSystemConfig)

--• [Undocumented Types](#Undocumented-Types)

• [D.5. Constants](#d5-constants) | -| [E. **Usage And Examples**](#E-Usage-And-Examples)
| -| [F. **Showcase, Tests and Demos**](#F-Showcase-Tests-and-Demos)
| -| [G. **Meta**](#G-Meta)
| -| [H. **Licence**](#H-Licence)
| +| [E. **Usage And Examples**](#E-Usage-And-Examples)
📝 **Note**: See [Example List](#example-list) section for a complete list of examples. | +| [F. **Showcase, Tests and Demos**](#F-Showcase-Tests-and-Demos) | +| [G. **Meta**](#G-Meta) | +| [H. **Licence**](#H-Licence) |