Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom background - Editor #3280

Closed
wants to merge 6 commits into from
Closed

Conversation

shmolf
Copy link
Contributor

@shmolf shmolf commented Oct 17, 2019

Description

An additional setting is created for the user to provide a path to a background image.
The input takes in a URI like

  • https://example.com/image.png
  • file:///C:/Users/userName/images/favoriteBackground.png
    The input will inevitably be used in a CSS attribute (background-image: url(path)), and so should adhere to the CSS restrictions.

The background is applied to the Editor, and uses CSS's background blending for a translucent appearance.

It is not applied to the Snippets editor, only the Markdown Editor.

The background image doesn't update on settings change. Only when CodeMirror is refreshed.
So, switching notes will update the background, but simply changing the setting does not. This is a limitation on my skills, as I've never worked with React before.

Background will update when the setting is saved.

Demonstration

custom-background


I accidently included in this pull request, the addition of Custom CSS to the en.json file. It was a missing value, but isn't directly related to the new feature.

Type of changes

  • 🔘 Bug fix (Change that fixed an issue)
  • ⚪ Breaking change (Change that can cause existing functionality to change)
  • ⚪ Improvement (Change that improves the code. Maybe performance or development improvement)
  • 🔘 Feature (Change that adds new functionality)
  • ⚪ Documentation change (Change that modifies documentation. Maybe typo fixes)

Checklist:

  • 🔘 My code follows the project code style
  • ⚪ I have written test for my code and it has been tested
  • 🔘 All existing tests have been passed
  • 🔘 I have attached a screenshot/video to visualize my change if possible

@ZeroX-DG ZeroX-DG added the awaiting review ❇️ Pull request is awaiting a review. label Oct 17, 2019
@shmolf
Copy link
Contributor Author

shmolf commented Nov 5, 2019

@Flexo013 I don't know if you're the appropriate person to ask...
Is this merge holding on something?

@shmolf
Copy link
Contributor Author

shmolf commented Nov 5, 2019

In the most recent commit, I've fixed the issue of the background not updating immediately upon change. Also found some bad variable references from one of my prior commits.

custom-background

@Flexo013
Copy link
Contributor

Flexo013 commented Nov 5, 2019

There are quite a few PRs awaiting a review, so the highest priority ones get picked up first.

Also, I don't think anybody requested this feature (there is no GitHub issue for it). So this might be considered a feature that is too much bloat, but that is up to the reviewers/community. It could be worth to make a discussion/feature request issue to see if people want this.

As a final note, is this not already sufficiently achievable with the custom CSS?

@shmolf
Copy link
Contributor Author

shmolf commented Nov 6, 2019

I will create a Feature Request. Is there a good medium/channel to present it, or just allow for natural discovery from the community?

Also, the custom CSS is specific to the Preview side. Config supports this

@shmolf
Copy link
Contributor Author

shmolf commented Nov 6, 2019

Created the Feature Request issue: #3343

@arcturus140
Copy link
Contributor

you can link to the feature request in slack channel

@ZeroX-DG
Copy link
Member

Close due to considered as bloat by community :(

@ZeroX-DG ZeroX-DG closed this Nov 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review ❇️ Pull request is awaiting a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants