|
| 1 | +# Using Custom Dialogs with SharePoint Framework Extensions |
| 2 | + |
| 3 | +Introduction |
| 4 | + |
| 5 | +Dialog is also avaialble for web parts. |
| 6 | + |
| 7 | +> Notice that the SharePoint Framework dialog is currently in preview status and we are looking to collect feedback before it's officially released. Please provide us feedback by using the [sp-dev-docs repository Issue list](https://github.com/SharePoint/sp-dev-docs/issues). |
| 8 | +
|
| 9 | +## Setup your Environment |
| 10 | + |
| 11 | +Before you can complete this guide you will need to ensure you have [setup your environment](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) for development |
| 12 | +using SharePoint Framework and that you are using latest SharePoint Framework Yeoman templates. |
| 13 | + |
| 14 | +> You can update your SharePoint Framework Yeoman templates by running following command `npm install -g @microsoft/generator-sharepoint`. |
| 15 | +
|
| 16 | +## Create a New Project |
| 17 | + |
| 18 | +Start by creating a new folder for the project using your console of choice: |
| 19 | + |
| 20 | +```sh |
| 21 | +md dialog-cmd |
| 22 | +``` |
| 23 | + |
| 24 | +And enter that folder |
| 25 | + |
| 26 | +```sh |
| 27 | +cd dialog-cmd |
| 28 | +``` |
| 29 | + |
| 30 | +The run the Yeoman generator for SharePoint Framework |
| 31 | + |
| 32 | +```sh |
| 33 | +yo @microsoft/sharepoint |
| 34 | +``` |
| 35 | + |
| 36 | +When prompted: |
| 37 | + |
| 38 | +* Accept the default value of **dialog-cmd** as your solution name and press **Enter**. |
| 39 | +* Choose **Extension (Preview)** as the client-side component type to be created. |
| 40 | +* Choose **ListView Command Set (Preview)** as the extension type to be created. |
| 41 | + |
| 42 | +The next set of prompts will ask for specific information about your extension: |
| 43 | + |
| 44 | +* Accept the default value of **DialogDemo** as your extension name and press **Enter**. |
| 45 | +* Accept the default value of **DialogDemo description** as your extension description and press **Enter**. |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | +At this point, Yeoman will install the required dependencies and scaffold the solution files along with the **HelloWorld** extension. This might take a few minutes. |
| 50 | + |
| 51 | +When the scaffold is complete, you should see the following message indicating a successful scaffold: |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +For information about troubleshooting any errors, see [Known issues](../basics/known-issues). |
| 56 | + |
| 57 | +Once the solution scaffolding is completed, type the following into the console to start Visual Studio Code. |
| 58 | + |
| 59 | +``` |
| 60 | +code . |
0 commit comments