Skip to content

About

A set of core solid-compatible apps based on solid-ui

Topics

Resources

Stars

106 stars

Watchers

26 watching

Forks

Repository files navigation

solid-panes

A set of core solid-compatible applets based on solid-ui

These are a set of interlinked applications, or parts of applications, which called 'panes' -- as in parts of a window. A pane displays a data object of certain class using part of the window. They don't tile like window panes necessarily, but one pane can involve other panes to display objects related to the main object, in all kinds of creative ways. You can give the sub-pane a bit of HTML DOM element to work in, and the data object, and it does the rest.

You can explicitly invoke a specific sub-pane, or you can just provide a DOM element to contain it, and ask the pane system to pick the appropriate pane. It does this by calling each potential pane in order with the object, and asking whether it wants to render that object. Typically the pane chosen is the most specific pane, so typically a hand-written user interface will be chosen over a generic machine-generated one.

These panes are used in the Data Browser - see mashlib https://github.com/linkeddata/mashlib

Currently the panes available include:

  • A default pane which lists the properties of any object
  • An internals pane which allows the URI and the HTTP fetch history to be checked
  • A pane for Address Books, Groups as well as individual Contacts
  • A pane for seeing pictures in a slideshow
  • A pane for a playlist of YouTube videos
  • A pane for a range of issue trackers, to-do-lists, agendas, etc
  • A file and directory manager for a Solid/LDP hierarchical file store
  • A Sharing pane to control the Access Control Lists for any object or folder
  • and so on

The solid-app-set panes are built using a set of widgets and utilities in https://github.com/linkeddata/solid-ui

To help onboarding, we're using roles to limit the number of panes presented to new users.

Goals

  • Make the system module in terms of NPM modules; one for each pane

  • Allow (signed?) panes to be advertised in turtle data in the web, and loaded automatically

  • Allow a Solid user to save preferences for which panes are used for which data types.

  • Create new panes for playlist and photo management and sharing, fitness, etc

Volunteers are always welcome!

Documentation

Profile heading

Page shells can call initializeProfileHeading(getPageUrl) with a function returning the currently browsed resource URL. Without an argument, the heading uses window.location.href. The function is evaluated on each refresh, including authentication changes, so shell-specific URL/query parsing stays in the shell. Call refreshProfileHeading(true) after changing the shell's target.

The solid-panes-profile-heading component accepts presentation data through profileData. Its boolean compact property (also available as an attribute) halves the responsive avatar size and shows only the photo, name, and job title. The page controller uses the full heading on the profile pane and compact mode on every other pane where the heading is visible. Owner editing remains exclusive to the profile pane. On storage panes, the heading is shown only when the active storage URI matches the viewed profile's navbar entry. Opening the logged-in user's storage from the header menu hides the heading, even when the URL still points to someone else's profile. Reloading a WebID URL always shows its profile with Profile selected in the navbar. On a container or resource URL (not a WebID) the page shows the resource as usual with the navbar visible and nothing selected; choosing Storage in the navbar replaces that view with the whole storage, with the container or resource from the URL opened inside it. Any other pane on a page inside someone else's pod (for example their container) shows the compact heading of that pod's owner; it is hidden inside the viewer's own pod and for account-menu views. Pressing Enter on the current URL, or using the browser's back and forward buttons, re-renders the page without a reload, and like a reload shows what the URL is: the profile on a WebID (selected in the navbar), otherwise the container or resource itself, whatever the history entry last displayed through the navbar or the account menu. Solid-panes locally presents the heading data and checks viewer edit access; the component owns the edit interaction and opens the local heading editor. The page controller refreshes the heading after a successful save. After a successful save the component also dispatches a bubbling, composed profile-heading-saved event with detail.subjectUri, which profile-pane uses to rerender sections such as More contacts. The heading editor includes its own dialog and responsive styles. On mobile, the edit icon sits closer to the heading's top-right edge while preserving its full touch target.

On the profile pane, logged-in visitors viewing someone else's profile also see an "Add as friend" action to the left of Edit (when available). The page controller sets friendSubject only in that context. The action loads the viewer's profile, checks foaf:knows, and saves the new friendship in the viewer's profile document. Existing friends have a disabled "Already a friend" button (hidden on mobile). Success and error messages are centered below the button, announced and focused, and dismissed after 10 seconds; failed operations can be retried. Anonymous visitors, owners, and other panes do not show this action. On mobile, friend actions sit in the top-right corner beside the name, which wraps as needed.

Navigation reuses the mounted heading, with a 300ms CSS transition for the avatar, padding, and detail rows in both directions. Transitions are disabled when the user prefers reduced motion. When navigating to a pane without a heading, the entire heading fades and collapses (including its outer spacing) over 300ms before removal. Navigating back during that animation cancels it and reuses the existing component. The reverse navigation fades and expands the full or compact heading and its outer spacing over 300ms, after the component has rendered. Reduced-motion users get immediate appearance and removal instead.

The navbar is hidden when the loaded URL is the logged-in user's WebID or its fragment-free profile document URL. Other URLs in the same pod and other users' profiles keep the navbar. Account-menu navigation continues to hide it.

Friends list

On your own editable profile, drop a friend's WebID anywhere in the social pane's friends list, including its empty space or an existing friend card, to add a foaf:knows link to your profile. The whole list is the drop target; there is no separate target icon. Other people's lists and non-editable profiles remain read-only. This uses solid-ui's existing attachment-list save and refresh handlers. Navigation icons are rendered directly by solid-ui using the imported Lucide square-arrow-out-up-right component in neutral gray and match the remove icons' size and right alignment. Remove-friend confirmations appear as compact popups centered over the list, above its contents and outside the clipped cards, including when there is only one friend. They do not change the list's layout. Cancel is focused when the confirmation opens. The pane passes solid-ui's optional confirmationContainer rather than relocating the widget's popup after it opens.

Development

To get started, make sure you have Node.js installed (for instance through nvm), then:

  1. Clone, install, and start the dev server:
git clone https://github.com/solidos/solid-panes
cd solid-panes
npm install
npm start
  1. Open http://localhost:5173 in your browser. You should see the pane development sandbox.

  2. You can change the subject in the sandbox to determine which pane gets rendered. For example, the default subject loads the profile-pane.

Using a local profile-pane

When working inside the SolidOS monorepo, profile-pane (and the other local workspaces) are symlinked by npx lerna bootstrap --force-local (run from the monorepo root, as npm run watch-pivot does), even if the version in package.json is not published to npm. Use a plain version in package.json (not a file: path, which lerna does not link) and avoid a bare npm install here, which fails for unpublished versions and removes the links.

Contributing panes

When you created a pane, you can either add it as an npm dependency of this repo (for instance meeting-pane, issue-pane, chat-pane are all imported in src/registerPanes.js), or add it under the src/ tree of this repo.

Eg. some RDF CLasses

Here, just to show how it works, are how some RDF Classes map onto panes. Anything to do with contacts (A VCARD Address Book, Group, Individual, Organization) can be handled by the one contact pane. Any other pane which wants to deal with contacts can just use the pane within its own user interface.

Mapping many classes on the L to panes on the R

Generative AI usage

The SolidOS team is using GitHub Copilot integrated in Visual Studio Code. We have added comments in the code to make it explicit which parts are 100% written by AI.

Prompt usage hitory:

  • Model Claude Opus 4.6: Initially solid-panes is loaded into an HTML shell form mashlib that looks like ... Also, an iFrame is rendered inside the <div class="TabulatorOutline" id="DummyUUID"> for “isolated pane rendering”. Analyze the solid-panes code for what it uses from this HTML and suggest a new HTML structure which is mobile and accessibility friendly. Let's go ahead and make changes in this code as suggested to accommodate the new databrowser HTML.

  • Raptor mini: take a look at how I wired the environment from mashlib into solid-panes. It is not quite right, can you suggest fixes?

  • Raptor mini: Update the code to use the new solid-ui-header component. Keep in mind the log in and sign up are wired in specific ways.

  • GPT-5.4 Model: Add a compatibility shim in the form pane for mixed ui:Group plus field typing.

About

A set of core solid-compatible apps based on solid-ui

Topics

Resources

Stars

106 stars

Watchers

26 watching

Forks

Releases

Packages

Used by

Contributors

Languages