Skip to content

Antoshjkee/umbraco-contentment

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contentment for Umbraco logo

Contentment for Umbraco

contentment /kənˈtɛntm(ə)nt/ - a state of happiness and satisfaction

What is it?

This is a collection of Umbraco components that I have developed for use on my own Umbraco 8 implementation projects.

Some components may be innovative, others may be a reimagining of existing components, property-editors, features and other community packages.

Why should I use it?

I'm sharing my code with the world. It is your choice (and responsibility) whether you would like to use it. No pressure or marketing spin from me.

What's on offer?

Let's take a look inside...

Property Editors
  • Bytes - a read-only label to display file sizes in relative bytes.
  • Content Blocks - a block editor, configurable using element types.
  • Data List - an editor that combines a custom data source with a custom list editor.
  • Icon Picker - an editor to select an icon (from the Umbraco icon library).
  • Notes - a read-only label to display rich-text instructional messages for content editors.
  • Render Macro - a read-only label dynamically generated from an Umbraco Macro.

Releases

Downloads are available on the releases page.

Known issues

  • Data List
    • When using the Umbraco Content data source with an XPath query, inside a Nested Content editor, it will not be able to identify the contextual containing node ID. e.g. your XPath query will not work. See #30 for details.

Documentation

Documentation for each of the components - with screenshots, use-cases and code examples - can be found in the /docs folder.

Please note, you may find other components within Contentment that have not yet been documented.
Let's call those "life's little surprises".

Support

I've been doing open source for a long time. I have suffered my fair share of burnout and empathy fatigue.

I reserve the right to address bug reports or feature requests in my own time, or ignore them completely.

Any feedback is warmly welcome. But please keep in mind, I am not your personal support developer.

If you are really stuck, do remember that the Umbraco community is amongst the friendliest on our planet, learn to embrace it.
Ask for help on the Our Umbraco support forum, I am sure someone can help you there.

Contributions, collaborations, rules of engagement

If you would like to contribute to this project, please start a discussion before spending time on a pull request. Your time is precious.

Please make sure that you read the CONTRIBUTING guidelines.

This project is governed by a Code of Conduct. Play nice or go home. ✌️❤️🕊️

If you are unhappy with the project or documentation, please help to identify specific issues and work towards resolving them. Otherwise you are completely free to not use this software, complain on your favourite social network, or shout into the void.

Unacceptable behaviour towards myself (or contributors) may result in being blocked from accessing this repository.

License

Copyright © Lee Kelleher.

All source code is licensed under the Mozilla Public License.

A note about licensing

Historically, I used the MIT license for my open-source projects, regretfully I no longer feel MIT reflects my spirit of encouraging open source collaboration. The main difference with the Mozilla Public License is that if you make any modifications to the source code, then you must make those changes publicly available.

More give, less take.

If you do not to intend to modify the source code, then you will still have the same freedoms as when using the MIT license.

For more information about the Mozilla Public License, please visit: https://www.mozilla.org/en-US/MPL/2.0/FAQ/

Acknowledgements

Developers

Current development effort: 810+ hours (between 2019-03-13 to 2020-08-28)

To give you an idea of how much human developer time/effort has been put into making this package.

Special thanks

  • Thank you to Umbrella for facilitating the time and resource to help me develop this project.

Logo

The package logo uses the Happy (by Nick Bluth) icon from the Noun Project, licensed under CC BY 3.0 US.

About

Contentment for Umbraco - a state of happiness and satisfaction

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 51.3%
  • JavaScript 24.5%
  • HTML 19.2%
  • PowerShell 2.6%
  • CSS 2.4%