Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opensmock/pyramid
Pyramid is a Graphical User-Interface (GUI) builder and editor for Bloc and Toplo.
https://github.com/opensmock/pyramid
bloc graphic-editor gui gui-builder hmi pharo pharo-smalltalk pyramid smalltalk toplo ui ui-builder ui-editor ux wysiwyg wysiwyg-editor
Last synced: about 1 month ago
JSON representation
Pyramid is a Graphical User-Interface (GUI) builder and editor for Bloc and Toplo.
- Host: GitHub
- URL: https://github.com/opensmock/pyramid
- Owner: OpenSmock
- License: mit
- Created: 2022-11-24T11:09:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T14:04:13.000Z (3 months ago)
- Last Synced: 2024-10-09T13:21:17.199Z (about 1 month ago)
- Topics: bloc, graphic-editor, gui, gui-builder, hmi, pharo, pharo-smalltalk, pyramid, smalltalk, toplo, ui, ui-builder, ui-editor, ux, wysiwyg, wysiwyg-editor
- Language: Smalltalk
- Homepage:
- Size: 1.41 MB
- Stars: 32
- Watchers: 1
- Forks: 6
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](./LICENSE)
[](https://github.com/OpenSmock/Pyramid/actions/workflows/Pharo11CI.yml)
[](https://github.com/OpenSmock/Pyramid/actions/workflows/Pharo12CI.yml)
# Pyramid
Pyramid is an User-Interface (UI) editor.
Pyramid is a WYSIWYG application (What You See Is What You Get) in other terms it allows you to visually design the expected outcome.
Pyramid helps you to produce final UI in Bloc and Toplo libraries.
The designed UI persistence is based on the "-Serialization" projects below. Pyramid saves a designed UI into a method as a string. Refer to the "-Serialization" projects to learn more.
You can add plugins into Pyramid to extend the editor capacities or create [your own plugin](https://github.com/OpenSmock/Pyramid/wiki/Add-a-new-plugin-to-Pyramid) with your specific functions!
## 
How to get Pyramid
You can load a release version of Pyramid or the latest development version.
Beware that Pyramid is currently in alpha development. The API is subject to significant changes, and stability is not guaranteed. Projects created during the alpha version are not designed to be compatible with newer versions of Pyramid.
Pyramid is available with Bloc and Toplo as defaults. If you want to build UI without Toplo, you can choose to load Pyramid with only Bloc using the baseline option `load: 'BlocUI'`. Here's an example script below.
To install a version of Pyramid, use one of the following scripts inside a playground.
### Latest development version
```st
Metacello new
baseline: 'Pyramid';
repository: 'github://OpenSmock/Pyramid:main/src';
load
```
Only with Bloc (without Toplo features):
```st
Metacello new
baseline: 'Pyramid';
repository: 'github://OpenSmock/Pyramid:main/src';
load: 'BlocUI';
load
```
### Release version
We advise you to use dependencies committed at the date of the Pyramid release (Bloc, Bloc-Serialization, etc.) to ensure compatibility with a release of Pyramid.
```st
Metacello new
baseline: 'Pyramid';
repository: 'github://OpenSmock/Pyramid:alpha4';
load
```
### Add in your baseline
```st
spec baseline: 'Pyramid' with: [ spec repository: 'github://OpenSmock/Pyramid:main/src' ].
```
## How to use Pyramid
### Create a new project
Open the Pyramid menu from the Library tab and click `New Project`.
Then the project view appears in a new window.
### Add and setup graphical elements
Use the add button to add graphical elements in your project view and edit them with the properties panel.
https://github.com/user-attachments/assets/44796af0-95d7-4e29-b28b-fdedfdbe7a85
### Test behavior in the editor
Use the test/edit button to switch between the edit mode and the test mode.
https://github.com/OpenSmock/Pyramid/assets/49183340/a85d8c01-89dd-472c-ab4e-41d51a8629dd
### Save and Edit a project
Setup the project to store your view into a Class.
When your project is saved into a method, you can see the preview on the `Pyramid preview` tab.
By default the element will be saved as source code.
Use the `Pyramid preview` tab to edit an existing project.
You can edit your project with Pyramid or use the code browser.
https://github.com/user-attachments/assets/14711a00-b31a-4915-a634-3685bfe141f7
### Test a project
Use the `Pyramid preview` tab to test an existing project.
https://github.com/OpenSmock/Pyramid/assets/49183340/12a916e5-06d1-426f-954c-2e4e911475e1
### Tips
To edit a `BlElement` instance or a `BlSpace` instance into Pyramid :
```st
element editWithPyramid.
space editWithPyramid.
```
You can edit in Pyramid all opened BlSpace with the `F12` keyboard shortcut, this feature can be disabled in the settings.
When a window is open in Pyramid, an image is displayed on it to attract the user's attention:
https://github.com/OpenSmock/Pyramid/assets/49183340/0c66a3ac-7bea-48c1-b1e8-0b093b1db4d5
## Plugins
- [FigmaToWorld](https://github.com/OpenSmock/Pyramid-Plugins-FigmaToWorld) plugin provides capacities to import projects designed with [Figma](https://www.figma.com)
## Dependencies
- [Bloc-Serialization](https://github.com/OpenSmock/Bloc-Serialization) - serializer project for Bloc (this project define the Bloc version of Pyramid).
- [Bloc](https://github.com/pharo-graphics/Bloc) - low-level UI infrastructure & framework for Pharo.
- [Toplo-Serialization](https://github.com/OpenSmock/Toplo-Serialization) - serializer project for Toplo (this project define the Toplo version of Pyramid).
- [Toplo](https://github.com/pharo-graphics/Toplo) - a widget framework on top of Bloc.
- [STON](https://github.com/svenvc/ston) - serializer for Pharo objects to Smalltalk Object Notation format.
- [Stash](https://github.com/Nyan11/Stash) - serializer for Pharo objects to source code format.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.