Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/hernanmd/SpecUIAddOns

Add-ons for Spec (Smalltalk UI description framework)
https://github.com/hernanmd/SpecUIAddOns

pharo pharo-smalltalk smalltalk spec ui ui-components

Last synced: about 2 months ago
JSON representation

Add-ons for Spec (Smalltalk UI description framework)

Lists

README

        

[![license-badge](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)

# Description

This package provides widgets for Spec 1 (Pharo Smalltalk UI description framework).

_NOTE: Currently since Pharo 10 only Spec 2 is supported. SpecUIAddOns is developed for Spec 1, hence it will NOT load correctly in Pharo versions >= 10._

# Installation

```smalltalk
Metacello new
baseline: 'SpecUIAddOns';
repository: 'github://hernanmd/SpecUIAddOns/repository';
load.
```

## Baseline String

If you want to add the ProjectFramework to your Metacello Baselines or Configurations, copy and paste the following expression:

```smalltalk
" ... "
spec
baseline: 'SpecUIAddOns'
with: [ spec repository: 'github://hernanmd/SpecUIAddOns/repository' ];
" ... "
```

# Screenshots

## Editable List

Provides a List with add, edit and remove items behavior. Add and edit buttons are automatically selected or deselected depending on current selection.

Operation buttons can be placed on top:

![Screenshot 1](screenshots/01_SpcEditableList_code_1.png)

Operation buttons can be placed on bottom:

![Screenshot 2](screenshots/01_SpcEditableList_code_2.png)

Widget with buttons on top and no items selected:

![Screenshot 3](screenshots/01_SpcEditableList_widget_1.png)

Widget with buttons on bottom and item selected:

![Screenshot 4](screenshots/01_SpcEditableList_widget_2.png)

## Labeled TextArea

TextArea code:

![Screenshot 5](screenshots/02_LabeledTextArea_code.png)

TextArea widget:

![Screenshot 6](screenshots/02_LabeledTextArea_widget.png)

## Labeled TextField with Button

TextField with an action button code:

![Screenshot 7](screenshots/03_SpcLabeledTextFieldWithButton_code.png)

TextField with action button widget:

![Screenshot 8](screenshots/03_SpcLabeledTextFieldWithButton_widget.png)

## Double Selector List

Provides two lists, two list acting as master-detail and a third one with items associated to the detail list.

![Screenshot 12](screenshots/05_SpcDoubleSelector_final.png)

## Toolbar with Buttons

![Screenshot 13](screenshots/06_SpcToolbarButtons_code.png)

![Screenshot 14](screenshots/06_Toolbar_2.png)

![Screenshot 15](screenshots/06_Toolbar_3.png)

## TextField in Wizard

![Screenshot 16](screenshots/07_SpcWizardTextField_code.png)

![Screenshot 17](screenshots/07_WizardTextField.png)

## Radio Button in Wizard

Provides vertically aligned radio buttons:

![Screenshot 18](screenshots/08_SpcWizardRadioButtonExample_code.png)

![Screenshot 19](screenshots/08_SpcWizardRadioButtonExample_widget.png)

## TextField Selector

![Screenshot 20](screenshots/09_SpcLabeledTextFieldSelector_1.png)

![Screenshot 21](screenshots/09_SpcLabeledTextFieldSelector_2.png)

![Screenshot 22](screenshots/09_SpcLabeledTextFieldSelector_3.png)

![Screenshot 23](screenshots/09_SpcLabeledTextFieldSelector_code.png)

## Searchable List

![Screenshot 24](screenshots/10_SingleSearchableMCList_code.png)

![Screenshot 25](screenshots/10_SingleSearchableMCList_widget_1.png)

![Screenshot 26](screenshots/10_SingleSearchableMCList_widget_2.png)

## TextField with Browse Button

![Screenshot 27](screenshots/11_SpcLabeledTextFieldWithBrowseButton_code.png)

![Screenshot 28](screenshots/11_SpcLabeledTextFieldWithBrowseButton_widget_1.png)

![Screenshot 29](screenshots/11_SpcLabeledTextFieldWithBrowseButton_widget_2.png)

## Growable search list

![Screenshot 30](screenshots/12_SpcGrowableSearchList_code.png)

![Screenshot 31](screenshots/12_SpcGrowableSearchList_widget_1.png)

![Screenshot 32](screenshots/12_SpcGrowableSearchList_widget_2.png)

# Usage notes

- It requires you already have some experience building Spec user-interfaces.
- Most widgets can be used by composition (i.e.: in the #instantiateModels: inside your #initializeWidgets). Some other widgets are intended to be subclassed.
- The SpecUIAddOns classes begins with Spc prefix.
- Most widgets implements example methods in the class side, category "examples"

# Contribute

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.

If you'd like to make some changes yourself, see the following:

- Fork this repository to your own GitHub account and then clone it to your local device
- Do some modifications
- Test.
- Add to add yourself as author below.
- Finally, submit a pull request with your changes!
- This project follows the [all-contributors specification](https://github.com/kentcdodds/all-contributors). Contributions of any kind are welcome!

# License

This software is licensed under the MIT License.

Copyright Hernán Morales Durand, 2018-2019.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# Authors

Hernán Morales Durand