Skip to content

Commit

Permalink
Merge pull request #424 from frontside-folio/jc/settings-docs-change
Browse files Browse the repository at this point in the history
STCOM-330 Change settings docs
  • Loading branch information
cherewaty authored Sep 18, 2018
2 parents 43d3a54 + 09631c6 commit b2dbf0b
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions doc/settings-and-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Instead, we will introduce a new top-level icon for Preferences, analogous to th

The only immediate requirement on the part of Stripes modules is that they be able to supply a preferences component, much as they presently have the option of supplying a settings component. Some modules will supply settings, some will supply preferences, some will supply both and some will supply neither.

Much code will likely be shared between the existing settings components and the new preferences components -- in particular, [the `<Settings>` component from stripes-components](https://github.com/folio-org/stripes-components/tree/master/lib/Settings), though this will need minor tweaking: it presently includes the hardwired caption "Module Settings" and the hardwired path `/settings`, both of which will need to be modified when used in a preferences context.
Much code will likely be shared between the existing settings components and the new preferences components -- in particular, [the `<Settings>` component from stripes-smart-components](https://github.com/folio-org/stripes-smart-components/tree/master/lib/Settings), though this will need minor tweaking: it presently includes the hardwired caption "Module Settings" and the hardwired path `/settings`, both of which will need to be modified when used in a preferences context.

Stripes-core will need extending to pick up preferences components from the modules it loads, as well as settings components, and to furnish a top-level preferences page. Again, much code will likely be re-used from the existing settings support.

Expand Down Expand Up @@ -104,5 +104,3 @@ However, from another perspective, it can be argued that the only part of a modu
Finally, we should give some thought to whether it makes sense to try to refactor the settings support out of stripes-core and into an actual module, ui-settings. If we did this, we would of course implement preferences in the same way, as another module.

Doing this would make the internal architecture of Stripes a better match for the UX, in which settings _looks like_ an application. Whether that is worth the work it would take is open to discussion -- especially as a putative ui-settings and ui-preferences would likely need access to parts of the Stripes internals that are currently hidden.


0 comments on commit b2dbf0b

Please sign in to comment.