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.

Sign up for GitHub

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

Jump to bottom

New documentation #92

Closed
34 of 35 tasks
radekmie opened this issue Aug 9, 2016 · 16 comments
Closed
34 of 35 tasks

New documentation #92

radekmie opened this issue Aug 9, 2016 · 16 comments
Assignees
@radekmie
Labels
Type: Feature New features and feature requests

Comments

@radekmie
Copy link
Contributor

radekmie commented Aug 9, 2016 •
edited
Loading

I'm starting to work on the new documentation. Here's a planned documentation summary. If you have any suggestions about what else should be included in here - please comment.

New documentation will be developed here - every suggestion and PR is welcome!

Playground is coming soon, don't worry.

  • Description
  • Installation
    • meteor
    • npm
  • Quick start
  • Overview
    • Forms components
    • Fields components
  • Advanced topics
    • Forms
      • Asynchronous validation
      • Hierarchy
      • Autosave
      • Post-submit handling
      • Validation options and modes
      • Example: ModifierForm
    • Fields
      • AutoField algorithm
      • Guaranteed props
      • Props propagation
      • Example: CustomAutoField
      • Example: CycleField
      • Example: RatingField
    • Schemas
      • SimpleSchema definition
      • Example: MyLittleSchema
    • Context data
      • Available context data
      • Example: Conditional display
      • Example: SubmitField
      • Example: SwapField
  • API
  • Troubleshooting
  • Contributing
  • Copyright and license
@radekmie radekmie added the Type: Feature New features and feature requests label Aug 9, 2016
@radekmie radekmie self-assigned this Aug 9, 2016
@radekmie radekmie mentioned this issue Aug 9, 2016
Closed
@serkandurusoy
Copy link
Contributor

It would be awesome if the contributing section described

  • setting up a local development environment
  • how to use a local, unpublished development version of uniforms in a test
    project

The last time I tried setting it up and trying to see if my changes fix a
known problem was a terrible experience, I could not get it to run so I was
not able to test if my PR fixed the problem or not.

On Wed, Aug 10, 2016 at 1:44 AM, Radosław Miernik notifications@github.com
wrote:

I'm starting to work on new documentation. Here's my planned documentation
summary. If you have any suggestions about what else should be included in
here - please comment.

  • Description
  • Quick start
    • Meteor
    • npm
  • Overview
    • Forms components
      • Autosave
      • Reset form
    • Fields components
      • Guaranteed props
      • AutoField algorithm
    • Advanced topics
    • Forms components
      • Asynchronous validation
      • Post-submit handling
      • Example: ModifierForm
    • Fields components
      • Props propagation
      • Example: CustomAutoField
      • Example: CustomBaseField
    • Custom schema
      • Example: MyLittleSchema
    • Context data
      • Example: SubmitButton
    • API
    • uniforms
      • Bridges
        • Bridge
        • SimpleSchemaBridge
        • createSchemaBridge
      • Fields
        • BaseField
      • Forms
        • AutoForm
        • BaseForm
        • QuickForm
        • ValidatedForm
        • ValidatedQuickForm
      • Helpers
        • changedKeys
        • connectField
        • filterDOMProps
        • injectName
        • joinName
        • nothing
        • randomIds
      • uniforms-bootstrap3
      • Fields
        • AutoField
        • AutoFields
        • BoolField
        • DateField
        • ErrorField
        • ErrorsField
        • FormGroup
        • HiddenField
        • ListAddField
        • ListDelField
        • ListField
        • ListItemField
        • LongTextField
        • NestField
        • NumField
        • RadioField
        • SelectField
        • SubmitField
        • TextField
      • Forms
        • AutoForm
        • BaseForm
        • QuickForm
        • ValidatedForm
        • ValidatedQuickForm
      • uniforms-bootstrap4
      • Fields
        • AutoField
        • AutoFields
        • BoolField
        • DateField
        • ErrorField
        • ErrorsField
        • FormGroup
        • HiddenField
        • ListAddField
        • ListDelField
        • ListField
        • ListItemField
        • LongTextField
        • NestField
        • NumField
        • RadioField
        • SelectField
        • SubmitField
        • TextField
      • Forms
        • AutoForm
        • BaseForm
        • QuickForm
        • ValidatedForm
        • ValidatedQuickForm
      • uniforms-semantic
      • Fields
        • AutoField
        • AutoFields
        • BoolField
        • DateField
        • ErrorField
        • ErrorsField
        • HiddenField
        • ListAddField
        • ListDelField
        • ListField
        • ListItemField
        • LongTextField
        • NestField
        • NumField
        • RadioField
        • SelectField
        • SubmitField
        • TextField
      • Forms
        • AutoForm
        • BaseForm
        • QuickForm
        • ValidatedForm
        • ValidatedQuickForm
      • uniforms-unstyled
      • Fields
        • AutoField
        • AutoFields
        • BoolField
        • DateField
        • ErrorField
        • ErrorsField
        • HiddenField
        • ListAddField
        • ListDelField
        • ListField
        • ListItemField
        • LongTextField
        • NestField
        • NumField
        • RadioField
        • SelectField
        • SubmitField
        • TextField
      • Forms
        • AutoForm
        • BaseForm
        • QuickForm
        • ValidatedForm
        • ValidatedQuickForm
      • Troubleshooting
  • Contributing
  • Copyright and license

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#92, or mute the thread
https://github.com/notifications/unsubscribe-auth/AEbz3BXc9gLRU5deYroJpn1zXPjcolPZks5qeQKygaJpZM4JgmPb
.

@radekmie
Copy link
Contributor Author

Great idea @serkandurusoy. I'll surely add it to the playground README, but probably also here - it might be useful.

@serkandurusoy
Copy link
Contributor

Thanks! I believe it would also help encourage contributions.

On Wed, Aug 10, 2016 at 10:43 AM, Radosław Miernik <notifications@github.com

wrote:

Great idea @serkandurusoy https://github.com/serkandurusoy. I'll surely
add it to the playground README, but probably also here - it might be
useful.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#92 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AEbz3BChSxMDWHSDELid9QxLBqmlGw5Wks5qeYEcgaJpZM4JgmPb
.

@vladejs
Copy link

vladejs commented Aug 10, 2016

It will be awesome to cover this use cases:

  1. Conditionally show form fields based on another's field value, for instance, when user chooses 'Book' in category list, the form shows an ISBN field.
  2. How to manage a list of custom fields, for example, I created an upload image custom component and don't know how to tell the schema to render a list of those components. Moreover, if I just tell it to render a list of standard TextField components but with type file, it just renders with type text:
images:
  type: [String]
  uniforms:
    type:'files'
  1. How to apply different option values to SelectField component, for instance, the list of categories should render with label capitalized:
<option value='books'>Books</option>

@radekmie
Copy link
Contributor Author

Thanks @vladejs!
All of those have been discussed more in-depth in their issues and surely should be included into documentation.

@vladejs
Copy link

vladejs commented Aug 11, 2016 via email

@radekmie
Copy link
Contributor Author

To be honest I can't remember... Maybe we talked about it internally? Despite of all - I'm currently writing this chapter, and it will be ready soon.

@radekmie
Copy link
Contributor Author

Okay @vladejs - it would be nice to hear, if everything is clear and you could add something more.

@vladejs
Copy link

vladejs commented Aug 11, 2016

is there a way to tell AutoForm component to render an horizontal form? Like this one

@radekmie
Copy link
Contributor Author

If you are using bootstrap themes, then form-inline class should do the work (at least, I think it should - I'm not a bootstrap expert). Maybe grid would suffice? It is already implemented.

If you are using semantic or unstyled theme, then no, there's no builtin way to do this - you can either create custom components to handle this or extend current ones and then make a PR. How to do that? I think the same way as grid is handled in bootstrap themes.

@vladejs
Copy link

vladejs commented Aug 12, 2016

The way I have it on my form is applying a col-md-4 class to labels and a col-md-8 class to inputs. So the question would be, how to apply custom classes to all form labels and inputs right from AutoForm component, something like:

<AutoForm labels-classes="col-md-4" input-classes="col-md-8" ... />

Or apply them field by field (this is how I do it in AutoForm with Blaze):

<AutoForm template="bootstrap-horizontal" ... >
  <afField label-class="col-md-4" input-col-class="col-md-8" />
  ...
</AutoForm>

I don't know if this have been already discussed though

@radekmie
Copy link
Contributor Author

That's exactly what is grid prop in bootstrap themes for. Just pass grid={4} to your AutoForm.

@vladejs
Copy link

vladejs commented Aug 13, 2016

It works!, but not with nested fields (those who are Array in schema) because they are rendered inside a Panel.

@radekmie
Copy link
Contributor Author

I think, that there's no good way to show inline form with an array field.

@radekmie
Copy link
Contributor Author

New documentation is quite ready. I've already swapped old README.md with the new one, CONTRIBUTING.md is also updated.

Does anyone have an idea for generating documentation from both JSDoc and propTypes? There are a lot of components right now, so doing it by hand is basically undoable.

@radekmie
Copy link
Contributor Author

Right now API docs will remain incomplete.
Playground issue: #98.

@radekmie radekmie mentioned this issue Oct 23, 2018
Closed
@radekmie radekmie moved this to Closed in Open Source Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@radekmie radekmie

Labels
Type: Feature New features and feature requests
Projects
Open Source
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@radekmie @serkandurusoy @vladejs