-
Notifications
You must be signed in to change notification settings - Fork 1
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
Adds the watermark component #6
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great work! high polish! 💯
@@ -0,0 +1,135 @@ | |||
import { Devvit } from "@devvit/public-api"; | |||
|
|||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggest moving the prop docs to separate JSDocs colocated with the props. when we document them in a big block like this, the IDE can't parse it and readability everywhere outside this site is much lower. you might be able to use @prop
syntax but I discourage it since it's so much more verbose and you have to keep the name in the docs aligned to the name in the code.
|
||
/** | ||
* A component that appends the watermark to the container it is wrapped around | ||
* @param appName - the app name that is specified in devvit.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these docs need to be on WatermarkProps.
props, | ||
context, | ||
) => { | ||
const is1stPartyApp = props.developer === "Reddit"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔕 I don't know if this varies across languages. I guess we're pretty single lingual right now regardless.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This watermark is a temporary solution and will be deprecated before translation is an issue
Copyedit.
Copyedit.
Description:
Adds a simple watermark component
🧪 Testing Steps / Validation
Tested in Play
✅ Checks