Script Lab, a Microsoft Garage project
Experiment with the Office JavaScript API without leaving Excel, Outlook, Word, or PowerPoint!
[!IMPORTANT]
This repo has been archived because the codebase was moved to a Microsoft-internal source. However, the Script Lab tool is still available.
Get Script Lab in Excel, Word, and PowerPoint, or Script Lab for Outlook, free from Microsoft AppSource.
Read the blog post on the future of Script Lab.
Topics
- What is Script Lab?
- Get Started
- Import someone else's snippet, or export your own
- Report a bug, or suggest a feature
- Stay up-to-date
- Contribute to Script Lab
- Rate and review
- Articles & FAQs
- External media coverage
- Code of Conduct
What is Script Lab?
Wouldn't it be crazy if you could launch Excel, click to open a small code window, and then instantly start writing and executing JavaScript that interacts with your spreadsheet?
Script lab is a tool for anyone who wants to learn about writing Office Add-ins for Excel, Outlook, Word, or PowerPoint. The focus is the Office JavaScript API, which is the technology you need for building Office Add-ins that run across platforms. Maybe you're an experienced Office developer and you want to quickly prototype a feature for your add-in. Or maybe you've never tried writing code for Office and you just want to play with a sample and tweak it to learn more. Either way, Script Lab is for you.
Script Lab has three main features:
- Code in a pane beside your spreadsheet.
- IntelliSense is there while you type so you can easily discover and use the Office JavaScript objects and methods. Script Lab uses the Monaco editor, the same tech that powers VS Code, so it's beautiful and lightweight.
- Samples are pre-installed with Script Lab, so you don't have to start from scratch
- Your can use any TypeScript features like arrow functions, template strings, and async/await (i.e., a good chunk of ES6 and ES7 features). But it's not only script: your snippets can also use HTML, CSS, and references to external libraries and data on the web.
- 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.
- If you create a snippet you'd like to share, you can copy it to your clipboard, save it as a GitHub gist. Then send the gist link to someone else to use on their computer.
- The Import feature lets you load other people's snippets.
Script Lab works in Office 2013 or later on Windows, Office on the web, or Office on Mac.
You can get Script Lab right now for free from Microsoft AppSource! It works for Excel, Word, and PowerPoint.
If you're interested in developing for Outlook, you can get Script Lab for Outlook, also free from AppSource.
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:
Get Started
Explore Office JavaScript API using Script Lab
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 "Copy to clipboard" button with the open snippet. You can share as a public GitHub Gist, or you can paste the snippet from the clipboard, and share it from there.
Size restrictions
Script Lab is designed for you to play with small code samples. Generally, a snippet should be at most a few hundred lines and a few thousand characters.
Your snippet can use hard-coded data. A small amount of data (say, a few hundred characters) is OK to hard code in Script Lab. However, for larger pieces of data, we recommend that you store those externally then load them at runtime with a command like fetch.
Keep your snippets and hard-coded data small since storing several large snippets could exceed Script Lab's storage and cause issues when loading Script Lab.
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 on the web).
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! (see more at CONTRIBUTING.md).
If you have a question, please ask it on Stack Overflow and tag your questions with office-js and scriptlab.
Stay up-to-date
- Follow @OfficeDev on Twitter
- Follow Script Lab articles on medium.com
- Join our Office Developer program at developer.microsoft.com
Contribute to Script Lab
There are a bunch of ways you can contribute to Script Lab:
- File bugs & suggestions (see Report a bug, or suggest a feature).
- 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 (examples), 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!
Rate and review
Leave a star-rating and (optionally) a review blurb for Script Lab on the Office Store review page.
We'd prefer you report issues on GitHub.
Articles & FAQs
- Announcing Script Lab React (January 1, 2019): Official blog post
- Script Lab overview: "You can write JavaScript in Excel!"
- Project history & the technology behind it: Episode 127 on the Office 365 Developer Podcast
External 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: [German] "Prototyping von Microsoft Office JavaScript Add-Ins mit Script Lab". (Auto-translation: "Prototyping Microsoft Office JavaScript add-ins with Script Lab"), by Mourad Louha
- 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
Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
