Snippets

Please wait!

These steps are outdated for the upcoming v4.0.0 release of Schooltape.

Please wait for them to be updated before contributing snippets

Public Snippets

1. Append your snippet to the bottom of SNIPPET_INFO in src/utils/constants.ts

   export const SNIPPET_INFO: Record<string, SnippetInfo> = {
     hidePfp: {
       name: "Hide PFP",
       description: "Hide your profile picture across Schoolbox.",
       order: 0,
     },
     // ..
     <yourSnippetName>: { 
       name: "<Your Snippet Name>", 
       description: "<Your Snippet Description>", 
       order: "<Next Order Number>", 
     }, 
   };

2. Append your snippet to the bottom of snippets in src/utils/storage.ts

   export const snippetSettings = storage.defineItem<Types.SnippetSettings>("local:snippetSettings", {
     // ..
     defaultValue: {
       // ..
       snippets: {
         hidePfp: {
           toggle: true,
         },
         // ..
         <yourSnippetName>: { 
           toggle: false, 
         }, 
       },
     },
   });

3. Create a new file in src/public/snippets with the name <yourSnippetName>.css
4. Put in your CSS code and test it!

User Snippets

Snippets can also be added manually by the user. Create a snippet, following this format and then share it with your friends! These snippets are able to be removed by the user after installation.

Make sure to include the css comments

• Do not use quotation marks
• Make sure it is spelt correctly
• Leave a trailing newline character

/* name: Hide PFP */
/* description: Hide your profile picture across Schoolbox */

FAQ

Q: How do I install my user snippet?

A: Copy the gist URL into the input box (Schooltape popup > Snippets > User Snippets > Gist URL)

You can find and share snippets in the Schooltape Discord