Script Lab, a Microsoft Garage project
Note: Script Lab was re-written from the ground up in 2018, on a brand-new technology stack, including React and Fabric React. For the older version of Script Lab 2017, see more below.
- What is Script Lab?
- Get started
- Import someone else's snippet, or export your own
- Report a bug, or suggest a feature
- Script Lab vs "Script Lab 2017"
- Use Script Lab with older Office versions (Office 2013)
- Stay up-to-date
- Rate and review
- Contribute to Script Lab
- Articles & FAQs
- External blog posts & media coverage
What is Script Lab?
- Run the code in another pane beside the editor. Execution can include logic, API calls to Office, UI in the pane, and even output to a console. Every time you make a code change you can refresh the editor and run the new version in seconds.
- Share your snippets through GitHub. If you create a snippet you'd like to share, you can use Script Lab to save it. Then send the link to someone else to try it and tweak it on their computer. The Import feature lets you load other people's snippets.
You can install Script Lab right now for free from the Office Store! It works for Excel, Word, and PowerPoint. You'll need Office 2013 or later, Office Online, or Office for Mac.
Script Lab is a Microsoft Garage project that began at a hackathon. You can read the story of the original Script Lab creation on the Garage website.
Here's a 1-minute teaser video to give you a taste:
The easiest way to try Script Lab is with the Tutorial file for Excel that walks you through the tool in a few steps. You can get it here: script-lab-tutorial.xlsx
Alternatively, you can start from scratch and install Script Lab from the Store.
This 10-minute demo explains how to use the main features:
Import someone else's snippet, or export your own
Script Lab is built around sharing. If someone gives you a URL to a GitHub GIST, simply open Script Lab, use the hamburger menu at the top left to see the menu, and choose "Import" category (either on the left or top, depending on the available screen space). Then, enter the URL of the GIST, and click the "Import" button at the bottom of the screen. In just these few clicks, you will be able to view and run someone else's snippet!
Conversely, to share your snippet with someone, choose the "Share" menu within a particular snippet. You can share as a public or private GitHub Gist, or you can copy the entire snippet metadata to the clipboard, and share it from there.
Report a bug, or suggest a feature
To report a bug, create a new issue. Please provide as much detail as you can: tell us the operating system, the Office build number, and your browser (if you're using Office Online).
If you have a suggestion for a feature, please feel free to file it under "issues" as well, and we will tag it appropriately. The more detail, the better! We also gladly accept pull requests... (see more at CONTRIBUTING.md).
Finally, if you have a question, please ask it on https://stackoverflow.com instead. Tag your questions with
Script Lab vs. "Script Lab 2017"
Script Lab was re-written from scratch in 2018. Though its visual design remains similar to the 2017 version, its technology stack was overhauled to use React and Fabric React. Among the improvements are keyboard accessibility, a much faster runner, and user-configurable settings.
If you encounter issues or need one of the few features that haven't been ported over yet, you can -- for the time being -- switch to the 2017 version of Script Lab. To do so:
- Open the editor pane and select or create a snippet.
- In the bottom right of the editor, click the cog icon to open the settings.
- In a dropdown that will now appear on the left side of the footer, choose "Script Lab 2017" (instead of your current environment).
The original repo of the 2017 version, now in a mostly-archival state, can be found at https://github.com/OfficeDev/script-lab-2017.
Use Script Lab with older Office versions (Office 2013)
Office 2013 has several limitations compared to more recent versions.
Second, Office 2013 (and Office 2016 RTM, if you don't have an Office 365 subscription) does not support ribbon buttons for Script Lab. As a result, there's a different way to access the Code and Run functions:
- To Code, select the INSERT tab and choose My Add-ins, then insert Script Lab.
- To Run a snippet, click the small Run triangle icon at the top of the Script Lab code pane.
- Follow @OfficeDev on Twitter
- Follow Script Lab articles on medium.com
- Join our Office Developer program at dev.office.com
Contribute to Script Lab
There are a bunch of ways you can contribute to Script Lab:
- File bugs & suggestions (see more in "Report a bug, or suggest a feature" above).
- Contribute new samples, or improve existing one. Please submit a pull request to the office-js-snippets repo; more info in the README of that repo.
- Spread the word! Whether through writing a blog post (README.md#external-posts), recording a video, tweeting about us, or sharing snippets with colleagues or the StackOverflow community -- we want more of the world to use Script Lab!
- Help improve the documentation. If you feel like this README or the CONTRIBUTING.md doc could use more details, please send a pull request!
Finally, if you want to contribute code (bug fixes, features, localization, etc.), please see CONTRIBUTING.md to get you up and running with a local copy of Script Lab -- and then send us a pull request.
Rate and review
Leave a star-rating and (optionally) a review blurb for Script Lab on the Office Store review page.
Of course, we'd prefer that if you have issues you report them on GitHub instead, but you're free to leave any review comments you wish.
Articles & FAQs
- Announcing Script Lab React (January 1, 2019): Official blog post
- Project history & the technology behind it: Episode 127 on the Office 365 Developer Podcast
External blog posts & media coverage
- August 29, 2017: "Start Developing in OfficeJS Today with Script Lab" by David Craig at theofficecontext.com
- July 30, 2017: [German] "Eigene Script Lab Scripte in Office Online testen". (Auto-translation: "Test your own Script Lab scripts in Office Online") by Mourad Louha
- June 14, 2017: [Portuguese] "Script Lab: Novo add-in da Microsoft". (Auto-translation: "Script Lab: New Microsoft add-in"), by Leonardo Xavier.
- May 1, 2017: [Portuguese] "Microsoft lança o Script Lab". (Auto-translation: "Microsoft Launches Script Lab"), by Felipe Costa Gualberto.
- April 18, 2017: "Microsoft Garage Releases Script Lab" by Ryan Maskell at winbuzzer.com